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.

Sign up for GitHub

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 module-level doc comments for binary #7

Open
volks73 opened this issue Mar 17, 2021 · 0 comments
Open

Add module-level doc comments for binary #7

volks73 opened this issue Mar 17, 2021 · 0 comments
Assignees
@volks73
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@volks73
Copy link
Owner

volks73 commented Mar 17, 2021

Module-level doc comments should be added to the binary module (main.rs). This will act as the help documentation and will eventually be hosted on this project's GitHub pages. The comments should include more advanced usage examples and details.
@volks73 volks73 added the enhancement New feature or request label Mar 17, 2021
@volks73 volks73 self-assigned this Mar 17, 2021
@volks73 volks73 added the documentation Improvements or additions to documentation label Mar 17, 2021
@volks73 volks73 mentioned this issue Mar 20, 2021
Closed
volks73 added a commit that referenced this issue Mar 24, 2021
@volks73
Start adding module-level documentation
f0a7c89 
The usage examples from the README are slowly being moved to the module
doc comments for the binary. The README should provide high level
"getting started" documentation and the usage examples are more
appropriate for a tutorial. The module-level doc comments are being
created in a tutorial style. See #7.
volks73 added a commit that referenced this issue Mar 24, 2021
@volks73
Refactor to more modules
f607667 
The "app" components are moved to their own `app` module. This makes the
`main.rs` very short and sweet, which leaves plenty of room for writing
application-level documentation in the form of module-level doc comments
to be added without making the file too large.

This also allows the visibility of some modules to be changed to
private, which highlighted some functions, methods, and constants were
unused. This is related to #6 and #7.
volks73 added a commit that referenced this issue Mar 24, 2021
@volks73
Add another example to the tutorial
71951d9 
Related to #7.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@volks73 volks73

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@volks73