JuliaManifolds / Manifolds.jl

Manifolds.jl provides a library of manifolds aiming for an easy-to-use and fast implementation.
https://juliamanifolds.github.io/Manifolds.jl
MIT License
367 stars 52 forks source link

fix typos #728

Closed spaette closed 2 months ago

spaette commented 2 months ago

Closes https://github.com/JuliaManifolds/Manifolds.jl/issues/727

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 42.14%. Comparing base (c298c08) to head (57e6cc9).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #728 +/- ## =========================================== - Coverage 99.58% 42.14% -57.44% =========================================== Files 114 114 Lines 11230 11111 -119 =========================================== - Hits 11183 4683 -6500 - Misses 47 6428 +6381 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mateuszbaran commented 2 months ago

Thanks! I will check the CI failure, it looks unrelated to changes in this PR.

kellertuer commented 2 months ago

The CI failure is just the changelog, we can change/add a note on fixed typos in there on another PR.

mateuszbaran commented 2 months ago

No, there is something wrong with our FiniteDifferences.jl extension.

mateuszbaran commented 2 months ago

I tried fixing it in #729. Making a copy is not ideal but FiniteDifferences.jl doesn't like SVector.

spaette commented 2 months ago

a note on fixed typos

please draft a note and post it here

kellertuer commented 2 months ago

Sure. Start a new subheading for a new version (maybe as unreleased or with todays date) and therein have a ### Changed subsubheading.

There you could just add a line that several typographical errors were fixed. We will add a few points in the next few PRs before we register a new version (and maybe Mateusz newest PR/fix is such a vision as well).

So maybe

* files several typographical errors throughout the documentation

? You can also add how you encountered them, but along would be my phrasing.

spaette commented 2 months ago

my draft change to NEWS.md

  ## [0.9.19] – unreleased

  ### Changed

- * fixed a few typos in the doc string of the SPD fixed determinant description.
  * Updated `Project.toml` compatibility entries.

+ ### Fixed
+ 
+ * a few typos in the doc string of the SPD fixed determinant description
+ * several other typographical errors throughout the documentation
+ 
  ## [0.9.18] – 2024-05-07
kellertuer commented 2 months ago

Looks good. You could also just commit that here and I would comment on the code (probably even with a proposed change).

spaette commented 2 months ago

@kellertuer

MetricManifold.jl typo Copute corrected

NEWS.md edited as per agreement

performed soft reset

spaette commented 2 months ago

cf: failed CI / Julia ~1.10.0-0 - test_manifolds - ubuntu-latest (pull_request)

owing to this pull's edit of NEWS.md

it might be preferable to schedule a NEWS.md entry for whatever fix is decided upon for the cited failed test

until after this pull is merged

kellertuer commented 2 months ago

No worries, this is unrelated to your changes, it seems DifferentialEquations changed something they thought is nonbreaking but it actually was. This happens every now and then – I think they are just not careful enough.

But Mateusz has started the fix already at #729. And sure both PRs together would have a joint entry fpr the version then. Maybe we merge this one shortly before the other so Mateusz can take care of a joint entry :)