search

Sage-Bionetworks / schematic

Package for biomedical data model and metadata ingress management
https://schematicpy.readthedocs.io/en/stable/cli_reference.html
MIT License
22 stars 26 forks source link

Convert all in-code documentation to match style guide #128

Closed milen-sage closed 2 weeks ago

milen-sage commented 5 years ago

For example on well documented class with the correct style to be used by the documentation generator:

https://github.com/Sage-Bionetworks/HTAN-data-pipeline/blob/dev/MetadataModel.py

We need to convert all of our incode documentation to this level and using that style.

milen-sage commented 4 years ago

We need to generate usage docs.

ychae commented 3 years ago

@milen-sage does the above PR close this issue?

milen-sage commented 3 years ago

not yet - I think it needs more work...

ychae commented 2 years ago

can re-open if a more urgent need for it arises

milen-sage commented 2 years ago

@ychae let's keep this open actually. Will try to address during the refactor and we might need to coordinate here.

ychae commented 2 years ago

@milen-sage sounds good! I'll add it to one of the refactor milestones so we don't lose track of it.