added crate level documentation for smite core library#36
Open
psg-19 wants to merge 2 commits intomorehouse:masterfrom
Open
added crate level documentation for smite core library#36psg-19 wants to merge 2 commits intomorehouse:masterfrom
psg-19 wants to merge 2 commits intomorehouse:masterfrom
Conversation
morehouse
approved these changes
Apr 7, 2026
Owner
morehouse
left a comment
morehouse
left a comment
There was a problem hiding this comment.
Thanks, this is definitely an improvement.
I think it could be even better if we move the detailed descriptions of each module to the module files themselves and then have short one-line summaries of each module here. That's how rust docs are usually structured.
smite/src/lib.rs
Outdated
Comment on lines
+24
to
+29
| //! - [`runners`] - Runner abstraction for delivering fuzz inputs. | ||
| //! `NyxRunner` communicates with the Nyx hypervisor for | ||
| //! fast snapshot-based fuzzing, `LocalRunner` reads input | ||
| //! from a file or stdin for crash reproduction. `StdRunner` | ||
| //! auto-selects between them based on the `SMITE_NYX` environment | ||
| //! variable. |
Owner
There was a problem hiding this comment.
Also it would be helpful to mention that NyxRunner requires the nyx cargo feature to be enabled.
Author
Okay, I'll do this way. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The smite crate's
lib.rshad no documentation. This pr adds crate level doc comment explaining the library's purpose and descriptions of each module.