search

conda / conda

A system-level, binary package and environment manager running on all major operating systems and platforms.
https://docs.conda.io/projects/conda/
Other
6.48k stars 1.69k forks source link

Ensure that the docstrings for the project are descriptive and up to date #12613

Open travishathaway opened 1 year ago

travishathaway commented 1 year ago

What is the idea?

As we continue to open up conda with various plugin hooks, we would like to make sure that the code is easily read.

- [ ] https://github.com/conda/conda/pull/12620
- [ ] https://github.com/conda/conda/issues/12668
- [ ] Review all public class docstrings (see D101)
- [ ] Review all public method docstrings (see D102)
- [ ] Review all public function docstrings (see D103)
- [ ] Review all public package docstrings (see D104)
- [ ] Review all magic method docstrings (see D105)
- [ ] Review all public nested class docstrings (see D106)
- [ ] Review all `__init__` docstrings (see D107)
- [ ] Review nested `README.md`s (e.g. `conda/core/README.md`) and consider removing/combining into `__init__.py` docstrings
jezdez commented 1 year ago

The list of error codes are here: http://www.pydocstyle.org/en/6.3.0/error_codes.html