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

Refactor docs to provide stricter seperation between API and implemtation documention. #159

Open
elbenfreund opened this issue Jul 4, 2016 · 0 comments

Comments

@elbenfreund
Copy link
Collaborator

Right now, our documentation mixes API reference with implementation details. This is a direct consequence of efforts to reconstruct the legacy API on the fly and storing this knowledge in a accessable way.

In order to provide clean an focused documentation however, it is preferable to be stricter about those differing documentation aspects.

  • Docstrings shoudl provide a genreal API reference.
  • (Block)comments are to provide implementation notes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant