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

Add more detailed module-level documentation for all algorithms. #100

Closed
afck opened this issue Jul 2, 2018 · 1 comment
Closed

Add more detailed module-level documentation for all algorithms. #100

afck opened this issue Jul 2, 2018 · 1 comment
Assignees

Comments

@afck
Copy link
Collaborator

afck commented Jul 2, 2018

Every module should have an extensive description of what it does, and maybe even a short explanation of how it does it. (That explanation would be needed in the code anyway, to make it readable at all, so why not make it part of the module docs themselves.)

Once the API is stable (#66), we should add a usage example to every module, too.

@afck
Copy link
Collaborator Author

afck commented Jul 10, 2018

honey_badger is still missing docs. (And so is queueing_honey_badger, once it's merged.)

@afck afck reopened this Jul 10, 2018
@afck afck removed their assignment Jul 11, 2018
@afck afck self-assigned this Jul 18, 2018
@afck afck closed this as completed in #215 Aug 27, 2018
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