motleystate / moonstone

Library to perform Metagenomics data analysis with Python
https://moonstone.readthedocs.io/en/latest/?badge=latest
MIT License
1 stars 0 forks source link

Simplify documentation #65

Open khillion opened 3 years ago

khillion commented 3 years ago

Description

Some parts are redundant in the documentation when the listing is done, both in API docs and User guide.

We need to have only one listing, in API documentation.

AgnesBaud commented 2 years ago

I didn't see this issue before opening the #88 PR, but I was thinking of keeping the listing in available classes and have a more detailed listing (with listing of the methods) in API documentation, like what is done in the Filtering and Normalization API documentation. What do you think?

khillion commented 2 years ago

Yes sure! The important thing in my opinion is to make sure we do not have exactly the same things at two different places in the documentation.