Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct spelling #4522

Merged
merged 8 commits into from
Nov 1, 2024
Merged

correct spelling #4522

merged 8 commits into from
Nov 1, 2024

Conversation

t-bltg
Copy link
Collaborator

@t-bltg t-bltg commented Oct 24, 2024

Description

This is a code quality PR (hand corrections) fixing spelling typos (mostly in comments).

There are two ambiguities to be discussed:

  • Tesselation should be spelled Tessellation, but since those are variables, I haven't corrected them in Makie;
  • independant should be spelled independent, but this relates to a function in Bonito.jl so I haven't modified it to avoid disruption.

Type of change

This is a NFC.

@EdsterG
Copy link
Contributor

EdsterG commented Oct 24, 2024

Tesselation is a stuct defined in GeometryBasics.jl. There's a big breaking refactor currently happening, related to GeometryBasics, so might be a good time to correct the spelling? See #4477, #4319, #219.

@t-bltg
Copy link
Collaborator Author

t-bltg commented Oct 24, 2024

Tesselation is a stuct defined in GeometryBasics.jl.

Thanks for the clarification, and the links !
I also think this is best to change it, but I prefer to leave it for another PR, since this would be breaking.

@ffreyer
Copy link
Collaborator

ffreyer commented Oct 26, 2024

I cancelled the WGLMakie runs here because they were full of timeouts. I tried running CI on a different branch (https://github.com/MakieOrg/Makie.jl/actions/runs/11531218386/job/32101665605?pr=4472) and did not get timeouts, but rerunning here still produced them.
The changes here are just error strings and comments, right?

@t-bltg
Copy link
Collaborator Author

t-bltg commented Oct 26, 2024

The changes here are just error strings and comments, right?

Except some doc-strings and a few local variables renames here, https://github.com/MakieOrg/Makie.jl/pull/4522/files#diff-b49aa74de270f83f7d96f661d23e3e1044de710184415a64e5db70890a671841R225-R259, which have no impact elsewhere.

t-bltg and others added 3 commits October 30, 2024 16:58
Seems like the only change in the WGLMakie source to me that could possibly have an effect on anything, if interpolation of that string into javascript has some escaping bugs.
@t-bltg
Copy link
Collaborator Author

t-bltg commented Nov 1, 2024

Seems like the only change in the WGLMakie source to me that could possibly have an effect on anything, if interpolation of that string into javascript has some escaping bugs.

Wow that was a nice catch indeed 😲 !

@jkrumbiegel
Copy link
Member

@SimonDanisch looks like that single quote was the reason for the hangs, probably worth looking into the JS interpolation mechanism.

@jkrumbiegel
Copy link
Member

Thanks @t-bltg, we might also want to make typo catching more automatic in the future, I know other repos have added such CI workflows in the past and I guess you also used a tool rather than reading everything in the repo?

@t-bltg
Copy link
Collaborator Author

t-bltg commented Nov 1, 2024

I guess you also used a tool rather than reading everything in the repo

Of course there were a lot of false positive, but I've used codespell:
$ codespell --skip='*.js,*.vert,*.ai,*.frag,*.geom' . as a base here.

Seems like the corresponding gh action might be a start, should I add it to this PR, and configure it ?

@jkrumbiegel jkrumbiegel closed this Nov 1, 2024
@jkrumbiegel jkrumbiegel reopened this Nov 1, 2024
@jkrumbiegel
Copy link
Member

@t-bltg we can try that in a separate PR, depends on how well we can cut down the false positive rate. Maybe if detection is only run on the diff.

@t-bltg t-bltg mentioned this pull request Nov 1, 2024
@jkrumbiegel jkrumbiegel merged commit 9d55010 into MakieOrg:master Nov 1, 2024
37 of 40 checks passed
@jkrumbiegel
Copy link
Member

This is fine, one WGLMakie test is currently flaky, the rerun is not needed for me @t-bltg

@t-bltg t-bltg deleted the spelling branch November 1, 2024 12:16
@SimonDanisch
Copy link
Member

Is our ReferenceUpdater handling renaming correctly?

@jkrumbiegel
Copy link
Member

Is our ReferenceUpdater handling renaming correctly?

When you rename plots they appear in both the missing refimages and the new refimages section, so yeah that works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

5 participants