search

pylint-dev / pylint

It's not just a linter that annoys you!
https://pylint.readthedocs.io/en/latest/
GNU General Public License v2.0
5.26k stars 1.12k forks source link

Organisation of the dev/contributor documentation is hard to understand #7749

Open Pierre-Sassoulas opened 1 year ago

Pierre-Sassoulas commented 1 year ago

Question

The development guide is for plugin creator and the contributor guide is for pylint contributor but it's unclear what is supposed to be in How To Guides and Technical Reference. There's two places where information can be so it's hard to find what you search for.

Documentation for future user

Revamp of those parts to make it clearer. Maybe only the API need to be in the developer guide everything else should be in contributor guide. Redirection are already possible with : https://github.com/PyCQA/pylint/blob/main/doc/conf.py#L56

Additional context

https://github.com/PyCQA/pylint/issues/7636#issuecomment-1311017033

orSolocate commented 1 year ago

+1 to separate user/developer guide from contributor guide.