m2lines / gz21_ocean_momentum

Stochastic-Deep Learning Parameterization of Ocean Momentum Forcing
MIT License
5 stars 0 forks source link

Annotate code with docstrings; partial code lint #27

Closed jatkinson1000 closed 1 year ago

jatkinson1000 commented 1 year ago

Arthur adding docstrings where requested by @jatkinson1000

raehik commented 1 year ago

Rebasing onto main (previously was merging onto documentation branch, which doesn't seem too far away history-wise).

raehik commented 1 year ago

This branch was originally based off #17 . That PR would have probably been better as an issue to avoid branching & merging of subbranches - which is fine and dandy, but adds a layer of Git complexity and GitHub doesn't make merge targets very visible. I suggest we:

  1. merge this
  2. rebase #17 and merge any changes
  3. continue docs/linting work in smaller PRs

I've renamed this PR to clarify the changes it brings.

I've also rebased this to main. @arthurBarthe you'll need to "force pull" this to re-synchronize. This StackOverflow question explains it best:

git checkout arthurdocs # switch to this branch
git fetch --all # get all remote changes
git reset --hard origin/arthurdocs # change your local arthurdocs to use remote arthurdocs
raehik commented 1 year ago

I'll do the above, since we're not to lose any history, just have some messy branches for a minute.