Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Essential docs for more comfort code navigation #265

Open
donRumata03 opened this issue Mar 7, 2024 · 0 comments
Open

Essential docs for more comfort code navigation #265

donRumata03 opened this issue Mar 7, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@donRumata03
Copy link
Collaborator

It's a common practice to put short (only essential) docs in __init__.py files with general information what is the module responsible for.
That seems to be extremely useful for new contributors since it provides abstractions from authors' heads directly to docs while being pretty easy to create (only short docs are required).

Also, essential details of implementation of undocumented classes could be useful for the same reasons (full docs with listing all the parameters indeed seem redundant).

@donRumata03 donRumata03 added the documentation Improvements or additions to documentation label Mar 7, 2024
@donRumata03 donRumata03 changed the title Essential docs for more confort code navigation Essential docs for more comfort code navigation Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant