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

Fix typos #299

Merged
merged 4 commits into from
Oct 2, 2023
Merged

Fix typos #299

merged 4 commits into from
Oct 2, 2023

Conversation

DanielVandH
Copy link
Contributor

@DanielVandH
Copy link
Contributor Author

DanielVandH commented Oct 1, 2023

Follow up to #298. Took a lot longer than I thought (found some nice issues in the spellcheck that kept undoing my progress :-)) but I think it turned out alright.

If ever someone wants to do this procedure again, let me know and I can send you the github-spellcheck whitelist I've developed that removes a bunch of false-positive (built up automatically after removing over 9000 false-positives).

@codecov
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

Merging #299 (83b0fcc) into master (ba8d5cf) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #299   +/-   ##
=======================================
  Coverage   99.74%   99.74%           
=======================================
  Files          77       77           
  Lines        7084     7084           
=======================================
  Hits         7066     7066           
  Misses         18       18           
Files Coverage Δ
ext/ManoptLRUCacheExt.jl 100.00% <ø> (ø)
ext/ManoptManifoldsExt/manifold_functions.jl 100.00% <ø> (ø)
src/data/artificialDataFunctions.jl 100.00% <ø> (ø)
src/functions/adjoint_differentials.jl 100.00% <100.00%> (ø)
src/functions/bezier_curves.jl 100.00% <ø> (ø)
src/functions/costs.jl 100.00% <ø> (ø)
src/functions/differentials.jl 100.00% <ø> (ø)
src/functions/gradients.jl 100.00% <100.00%> (ø)
src/functions/proximal_maps.jl 100.00% <100.00%> (ø)
src/helpers/checks.jl 100.00% <ø> (ø)
... and 37 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@kellertuer kellertuer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice PR – thanks for spotting all those and carefully using a tool here!
Sometimes we might have rushed a bit too much concerning the docs – while we did document hopefully most keywords for example – we maybe were not 100% careful.

A few seems also to be a bit of copy paste continuations...

If you want, feel free to also add yourself to
https://github.com/JuliaManifolds/Manopt.jl/blob/master/.zenodo.json
as an „Other” – anyone contributing a function or (at least a few) corrections may add themselves :)

@kellertuer
Copy link
Member

Could you maybe write a forem entry (https://forem.julialang.org) or similar about the spellchecker? I would maybe want to run this on Manifolds or ManifoldsBase as well.

@DanielVandH
Copy link
Contributor Author

Sure, I'll try write something up today. I'll also send you the whitelist after so you can (hopefully) avoid many false positives.

@DanielVandH
Copy link
Contributor Author

@DanielVandH
Copy link
Contributor Author

DanielVandH commented Oct 2, 2023

whitelist.txt

and here is the whitelist (paste it at ~/.github-spellcheck/whitelist.txt).

@kellertuer
Copy link
Member

Super detailed, thanks!

@kellertuer kellertuer merged commit 48f5ab0 into JuliaManifolds:master Oct 2, 2023
13 checks passed
@DanielVandH DanielVandH deleted the fix-typos branch October 2, 2023 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants