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 #728

Merged
merged 1 commit into from
Jun 11, 2024
Merged

fix typos #728

merged 1 commit into from
Jun 11, 2024

Conversation

spaette
Copy link
Contributor

@spaette spaette commented Jun 8, 2024

Closes #727

Copy link

codecov bot commented Jun 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files
@@             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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Thanks for spotting so many typos and fixing them. 🏅

@mateuszbaran
Copy link
Member

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

@kellertuer
Copy link
Member

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

@mateuszbaran
Copy link
Member

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

@mateuszbaran
Copy link
Member

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

@spaette
Copy link
Contributor Author

spaette commented Jun 10, 2024

a note on fixed typos

please draft a note and post it here

@kellertuer
Copy link
Member

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
Copy link
Contributor Author

spaette commented Jun 10, 2024

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
Copy link
Member

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

@spaette
Copy link
Contributor Author

spaette commented Jun 11, 2024

@kellertuer

MetricManifold.jl
typo Copute corrected

NEWS.md
edited as per agreement

performed soft reset

@spaette
Copy link
Contributor Author

spaette commented Jun 11, 2024

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
Copy link
Member

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 :)

@mateuszbaran mateuszbaran merged commit b0008c0 into JuliaManifolds:master Jun 11, 2024
10 of 25 checks passed
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.

typos
3 participants