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

(0.9.0) Fix typos in code, docs, and docstrings #155

Merged
merged 28 commits into from
Nov 8, 2023

Conversation

pitmonticone
Copy link
Contributor

@pitmonticone pitmonticone commented Nov 4, 2023

This PR is a breaking change as it corrects spellings in the API. Changes in parameter names occur in:

  • LOBSTER
  • SLatissima
  • InstantRemineralisation

Copy link
Collaborator

@navidcy navidcy left a comment

Choose a reason for hiding this comment

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

Lgtm!

@jagoosw are these breaking changes?

Copy link

codecov bot commented Nov 5, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (8d3a355) 64.19% compared to head (74cdc73) 64.19%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #155   +/-   ##
=======================================
  Coverage   64.19%   64.19%           
=======================================
  Files          27       27           
  Lines        1064     1064           
=======================================
  Hits          683      683           
  Misses        381      381           
Files Coverage Δ
...c/Boundaries/Sediments/instant_remineralization.jl 79.16% <ø> (ø)
src/Boundaries/Sediments/simple_multi_G.jl 94.11% <ø> (ø)
src/Models/AdvectedPopulations/LOBSTER/LOBSTER.jl 70.00% <100.00%> (ø)
...AdvectedPopulations/LOBSTER/carbonate_chemistry.jl 100.00% <100.00%> (ø)
src/Models/AdvectedPopulations/LOBSTER/core.jl 100.00% <100.00%> (ø)
...rc/Models/AdvectedPopulations/LOBSTER/fallbacks.jl 100.00% <ø> (ø)
...ls/AdvectedPopulations/LOBSTER/oxygen_chemistry.jl 100.00% <100.00%> (ø)
src/Models/AdvectedPopulations/NPZD.jl 87.50% <ø> (ø)
src/Models/Individuals/SLatissima.jl 84.86% <100.00%> (ø)
src/OceanBioME.jl 68.75% <ø> (ø)
... and 1 more

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

README.md Outdated Show resolved Hide resolved
@navidcy
Copy link
Collaborator

navidcy commented Nov 6, 2023

@pitmonticone I added few suggestions for code alignment.

pitmonticone and others added 4 commits November 6, 2023 20:46
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
Co-authored-by: Navid C. Constantinou <navidcy@users.noreply.github.com>
@pitmonticone
Copy link
Contributor Author

@pitmonticone I added few suggestions for code alignment.

@navidcy Committed.

@jagoosw
Copy link
Collaborator

jagoosw commented Nov 6, 2023

Thank you @pitmonticone !

This is indeed a breaking change.

@navidcy if there are no changes needed could we add the latest Oceananigans compats in this PR before we push a minor release too?

@navidcy
Copy link
Collaborator

navidcy commented Nov 6, 2023

Sure, I can do that.

But I suggest we drop the support to previous Oceananigans since v0.90 introduced a big change to the API and I don't see how we could possibly support both pre-v0.90 and post/= v0.90.

@jagoosw
Copy link
Collaborator

jagoosw commented Nov 6, 2023

@navidcy updating to 0.90 might be quite a lot of work, I can sort it tomorrow if you want. I agree I don't think it's likely we could support both and I think we'd probably want to make some changes for consistency with it.

Perhaps that should be a different PR that we merge first.

@navidcy navidcy changed the title Fix typos in code, docs and docstrings Update to Oceananigans v0.90.1 + fix typos in code, docs, and docstrings Nov 6, 2023
@navidcy
Copy link
Collaborator

navidcy commented Nov 6, 2023

@jagoosw I just saw your post.

I already pushed changes in the Manifest+Project for Oceananigans v0.90. I looked through the examples and, to me, it didn't seem that we need to change anything. If the tests fail I'll revert my changes and we can open another one for Oceananigans v0.90.

how does this sound?

@navidcy
Copy link
Collaborator

navidcy commented Nov 6, 2023

@jagoosw, ok .. things fail.
let's update Oceananigans to v0.90.1 in a different PR and then merge this one

@jagoosw
Copy link
Collaborator

jagoosw commented Nov 7, 2023

@jagoosw, ok .. things fail. let's update Oceananigans to v0.90.1 in a different PR and then merge this one

I'll make a new PR, I suspect I may need todo some work for the light attenuation and gas exchange stuff as they use nodes.

@navidcy
Copy link
Collaborator

navidcy commented Nov 7, 2023

OK @pitmonticone, we'll wait for #157 first before merging this one. Once #157 is merged then we'll merge this one ;)

@jagoosw jagoosw mentioned this pull request Nov 8, 2023
@jagoosw jagoosw changed the title Update to Oceananigans v0.90.1 + fix typos in code, docs, and docstrings (0.9.0) Fix typos in code, docs, and docstrings Nov 8, 2023
@jagoosw jagoosw added documentation Improvements or additions to documentation package labels Nov 8, 2023
@navidcy
Copy link
Collaborator

navidcy commented Nov 8, 2023

@jagoosw, when tests pass I'll merge

@navidcy navidcy merged commit be8c0be into OceanBioME:main Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants