JuliaManifolds / Manopt.jl

πŸ”οΈManopt. jl – Optimization on Manifolds in Julia
http://manoptjl.org
Other
321 stars 40 forks source link

Fix typos #299

Closed DanielVandH closed 1 year ago

DanielVandH commented 1 year ago

PR created using https://github.com/tbroadley/github-spellcheck-cli.

DanielVandH commented 1 year ago

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[bot] commented 1 year ago

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

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

kellertuer commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

@kellertuer: See here https://forem.julialang.org/danielvandh/efficiently-fixing-typos-in-documentation-1j88. I hope it's clear enough.

DanielVandH commented 1 year ago

whitelist.txt

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

kellertuer commented 1 year ago

Super detailed, thanks!