improve docstrings #266
improve docstrings #266
Conversation
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @CunliangGeng and the rest of your teammates on |
CunliangGeng
force-pushed
the
update_docs_docstrings
branch
from
b3fa22d
to
6180b1a
Compare
- move code from `utils.py` to `__init__.py` - add docstring to module attributes - add schema content to docstring
CunliangGeng
force-pushed
the
update_docs_docstrings
branch
from
6180b1a
to
7409393
Compare
|
|
||
| This class is used to arrange the datasets required by NPLinker according to the | ||
| configuration. The datasets include MIBiG, GNPS, antiSMASH, and BiG-SCAPE. | ||
| ??? info "Concept and Diagram" |
There was a problem hiding this comment.
Is this a syntax that mkdocs recognizes and links to "Concept and Diagram"?
There was a problem hiding this comment.
No, that syntax is not for link but for creating a info block (or callout), the effect looks like (you could see that on doc website)
| >>> loader = DatasetLoader(config) | ||
| >>> loader.load() | ||
|
|
||
| See Also: |
There was a problem hiding this comment.
| See Also: | |
| See also: |
There was a problem hiding this comment.
Ruff requires that all section headers in a docstring should be capitalized and will automatically change also to Also. So let's use See Also:.
|
Before merging, fix the trailing whitespace that makes format checking fail ( |
Merge activity
|
|
Quite many small changes to the docstrings and docs to e.g.
...