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

Documentation #18

Open
malmans2 opened this issue Feb 8, 2022 · 2 comments · Fixed by #19
Open

Documentation #18

malmans2 opened this issue Feb 8, 2022 · 2 comments · Fixed by #19
Assignees
@malmans2
Labels
bug Something isn't working

Comments

@malmans2
Copy link
Member

malmans2 commented Feb 8, 2022

We are using docstrings and we described the Standardize methods in the README, but maybe we should create a dedicated wiki page with the API?
Nothing fancy, just a page reminding ourselves what's available.
@oceandie
Copy link
Contributor

oceandie commented Feb 8, 2022

Fine by me, but only if it is not too much trouble ;)

@malmans2 malmans2 mentioned this issue Feb 9, 2022
Merged
@malmans2
Copy link
Member Author

malmans2 commented Feb 9, 2022

pre-commit now generates docs/api.md. It's in main. For some reason the markdown generated by GH workflow is different, so the workflow shows a fail. Don't worry about it for now, I'll have a look. Just run pre-commit locally before merging.

@malmans2 malmans2 reopened this Feb 9, 2022
@malmans2 malmans2 self-assigned this Feb 9, 2022
@malmans2 malmans2 added the bug Something isn't working label Feb 9, 2022
@malmans2 malmans2 mentioned this issue Mar 28, 2022
Merged
@malmans2 malmans2 mentioned this issue Oct 4, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@malmans2 malmans2

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate API using pre-commit malmans2/nordic-seas-validation
2 participants
@malmans2 @oceandie