search

kymata-atlas / kymata-core

Core Kymata codebase, including statistical analysis and plotting tools
https://kymata.org
MIT License
5 stars 0 forks source link

Adds Documentation #268

Closed neukym closed 5 months ago

neukym commented 6 months ago

This PR aims to fix:

neukym commented 6 months ago

Going OK so far:

Screenshot 2024-05-26 at 23 06 06
neukym commented 6 months ago

To discuss with @caiw

neukym commented 6 months ago

Readme also updated:

Screenshot 2024-05-27 at 10 35 04
neukym commented 5 months ago

@anirudh1666 & @caiw - mkdocstring currently supports google style and numpy style docsctrings, with Sphinx only partially supported (https://mkdocstrings.github.io/griffe/docstrings/). As a result, I am starting with google style docstrings. @anirudh1666 - do you have an opinion on which docstring format you prefer, are you OK with Google style?

caiw commented 5 months ago

@neukym Absolutely fine with me to use Google style. PyCharm supports it.

neukym commented 5 months ago

@anirudh1666 I have moved the IPPM .md to the IPPM folder, as the /docs folder is now for formal documentation.

(actually - do we even need this .md file any more? how much of it has been superseded by the paper draft?)

neukym commented 5 months ago

Accepting without review due to this PR not including breaking code.