Issue 101: Add documention templates #104
Merged
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #104 +/- ##
=======================================
Coverage 97.74% 97.74%
=======================================
Files 6 6
Lines 133 133
=======================================
Hits 130 130
Misses 3 3 ☔ View full report in Codecov by Sentry. |
SamuelBrand1
approved these changes
Mar 1, 2024
|
@seabbs Can you sort the branch conflict? |
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.
This PR closes #101 by adding documentation templates for functions, methods, macros, types, and the overall module.
This is just a first pass and I would appreciate a detailed review as I 1. Found very few real-world examples and 2. Found it very hard to pass how to setup documentation for structs or how to get function documentation to correctly be based on the generic method whilst also documenting the typed fields for specific functions.