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

Move documentation from code to documentation module #36

Open
Melevir opened this issue Dec 10, 2013 · 0 comments
Open

Move documentation from code to documentation module #36

Melevir opened this issue Dec 10, 2013 · 0 comments

Comments

@Melevir
Copy link
Contributor

Melevir commented Dec 10, 2013

Sphinx docs are great, but there are to many of them. I mean, look: 10 lines of code and 20 lines of docs - ordinary case in the project.
This dramatically reduces maintainability - to many scrolling per action rate.
Good idea is to keep small doc strings where it's required and move other info to docs/ folder.
Doctests are not a problem also since we have unit tests now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant