search

starsimhub / styleguide

Guidelines for contributing to Covasim and other "starsim" models
MIT License
0 stars 0 forks source link

Add docs guidelines #3

Open cliffckerr opened 2 years ago

cliffckerr commented 2 years ago

Documentation on docs -- so meta :)

JSchripsema-IDM commented 2 years ago

We have guidance on IDM doc styles, RST templates, etc. here: https://docs.idmod.org/projects/doc-guidance/en/latest/

The repo is currently private, but we could discuss making it public and adding anything more specific for external contributions.

JSchripsema-IDM commented 2 years ago

A comment come up recently complaining about the relative lack of utility of writing docstrings for internal functions and then fighting with Sphinx autodoc--I'd love the org to have some code style guidelines beyond "use Google style" such as type annotation, marking functions as internal so Sphinx doesn't attempt to doc them, etc. This isn't really "my lane" but maybe with the breadth of roles we all have, we could come up with some recommendations.