Minimal documentation of cgp crate #45
Comments
marvin-hansen
added a commit
to marvin-hansen/cgp
that referenced
this issue
Dec 29, 2024
…cro components Addresses issue: contextgeneric#45 Add detailed Rust docstrings to core macro implementation files, improving code understanding and maintainability. Documentation follows Rust best practices with clear examples and detailed explanations. Each file's documentation includes: - Clear overview and purpose - Detailed function/struct documentation - Arguments and return value descriptions - Practical code examples - Implementation notes and edge cases - Type parameter explanations where applicable All examples are marked with `ignore` where they depend on the full CGP framework context. Documentation has been verified with `cargo test --doc` and `cargo doc`. Part of the ongoing effort to improve CGP framework documentation and usability. Signed-off-by: Marvin Hansen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
From the website:
"provide at least minimal documentation inside the cgp crate,
to help onboarding programmers to projects that use the cgp crate."
https://contextgeneric.dev/blog/early-preview-announcement/#document-the-cgp-crate
The goal is, to add the bare minimum to core crates to get programmers started
and guide contribors.
Non-goal is explaining concept, for that the book remains the reference.
The text was updated successfully, but these errors were encountered: