Add parameter documentation to every class/define #76
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
Member
rwaffen
commented
Dec 16, 2023
rwaffen
commented
- added parameter documentaion with the help of copilot
- remove lint ignore of missing parameters
- update references
- sort parameters
- added parameter documentaion with the help of copilot - remove lint ignore of missing parameters - update references - sort parameters
rwaffen
requested review from
bastelfreak,
ananace,
tuxmea and
SimonHoenscheid
ananace
approved these changes
Dec 18, 2023
There was a problem hiding this comment.
I can't see anything glaringly wrong with these documentation lines.
Some are very "what it says on the tin"-like, and could probably be written in a more helpful manner - but even so it's a definite improvement over not having any documentation strings at all.
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.