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.

Sign up for GitHub

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

Jump to bottom

What do we want to put in the doc? #10

Open
3 of 10 tasks
rcaneill opened this issue Jan 30, 2022 · 0 comments
Open
3 of 10 tasks

What do we want to put in the doc? #10

rcaneill opened this issue Jan 30, 2022 · 0 comments
Milestone
Version 1.0.0

Comments

@rcaneill
Copy link
Collaborator

rcaneill commented Jan 30, 2022 •
edited by DocOtak
Loading

What do we want to put in the doc?

I guess that we can keep the documentation quite simple, as it is just a wrapper around gsw. I guess these following points could / should be mentioned:

  • Some important links
    • to xarray
    • to gsw
    • to cf conventions
  • A description of the package
  • An example
  • A contributor guide with:
    • For new contributors, how to set the environment (git clone, install poetry, etc) -> See the actual README
    • For core devs, how to release
  • Maybe a list of what functions have been wrapped (should not be hard to automatize)
  • Other?
@rcaneill rcaneill added this to the Version 0.2.0 milestone Feb 1, 2022
@rcaneill rcaneill mentioned this issue Mar 17, 2022
Merged
@DocOtak DocOtak modified the milestones: Version 0.2.0, Version 0.2.1 Mar 22, 2022
@rcaneill rcaneill modified the milestones: Version 0.2.1, Version 0.3.1 Mar 23, 2022
@rcaneill rcaneill modified the milestones: Version 0.3.1, Version 1.0.0 Nov 29, 2022
@rcaneill rcaneill mentioned this issue Nov 29, 2022
Open
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Version 1.0.0
Development

No branches or pull requests
2 participants
@DocOtak @rcaneill