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

[Suggestion] Source Code Documentation #94

Open
kevinmatthes opened this issue Mar 31, 2023 · 0 comments
Open

[Suggestion] Source Code Documentation #94

kevinmatthes opened this issue Mar 31, 2023 · 0 comments

Comments

@kevinmatthes
Copy link
Collaborator

In my opinion, the source code should be documented at least with some very brief information, in the long term. This would help new contributors to add their ideas more easily to the current code base as they were able to look up the purpose of the defined symbols using cargo doc --open.

Furthermore, every crate which is published to crates.io can also be added to another project as dependency with access to the public symbols, i.e., also binary crates have a library mode.

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