Improve docs #8
Merged
Improve docs #8
Conversation
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
This file is used by GitHub.
This file is required by GitHub.
To avoid confusion, the top-level example(s) should always contain the module include().
Sub-directory should not be needed.
Perhaps this doc needs to be improved with more concrete / useful examples. For now, this will have to do.
kernelguy
approved these changes
Jan 28, 2025
Collaborator
kernelguy
left a comment
kernelguy
left a comment
There was a problem hiding this comment.
Just skimmed. Documentation is easier to read in generated output.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR add documentation for the vast majority of the currently implemented modules.
This includes:
For the Reviewer
Perhaps it is easiest to just accept this pull request, as it is, and allow the documentation to be deployed and then perform a review. Should there be any issues, then we can adapt the documentation.