search

JMMP-Group / nordic-seas-validation

MIT License
0 stars 0 forks source link

Documentation #18

Open malmans2 opened 2 years ago

malmans2 commented 2 years ago

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 commented 2 years ago

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

malmans2 commented 2 years ago

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.