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

Jump to bottom

Add documentation to Collector #30

Closed
seanchen1991 opened this issue Jun 13, 2020 · 1 comment · Fixed by #31
Closed

Add documentation to Collector #30

seanchen1991 opened this issue Jun 13, 2020 · 1 comment · Fixed by #31
Labels
T-documentation Improvements or additions to documentation

Comments

@seanchen1991
Copy link

The collector module seems to be a fundamental part of the library, and also one of the largest modules in terms of SLOC. Some more comprehensive docs for it would probably streamline the learning process for this module.
@Others
Copy link
Owner

Others commented Jun 13, 2020

Related to #11, but focusing on code docs instead of high level documentation.

I will try and get around to adding comments, but if you have any specific questions I can try and address them here. (Or you can PM me on the Rust discord @Others)

@Others Others added the T-documentation Improvements or additions to documentation label Jun 13, 2020
@Others Others mentioned this issue Jun 14, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation, slighly reorganize collector code Others/shredder
2 participants
@seanchen1991 @Others