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

update HISTORY.rst #409

Open
Mikejmnez opened this issue Jan 15, 2024 · 0 comments
Open

update HISTORY.rst #409

Mikejmnez opened this issue Jan 15, 2024 · 0 comments

Comments

@Mikejmnez
Copy link
Collaborator

  • OceanSpy version:
    0.35

Description

We need to update the history to describe the new changes implemented from version 0.34 to 0.35, with references to PRs with proper acknowledge to contributors. This is simply an update to the documentation. The way I do this is the following:

  • Run oceanspy within Sciserver. make sure that the new oceanography image and the fresh conda install of oceanspy work properly.
  • Run the tutorial notebooks within Sciserver. This ensures that there are no errors, deprecation warnings, and that overall the notebooks looks the way they should.
  • Follow the steps here https://oceanspy.readthedocs.io/en/latest/contributing.html#contributing-to-the-documentation. You can get the history from GH releases, but I like to write a paragraph that summarizes it in simple text...

I have some time this week and can do this myself. But I though it would be nice to write how I update the documentation.

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

No branches or pull requests

1 participant