Better documentation for annotations/attributes #1441
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
DerManoMann
requested changes
Apr 17, 2023
There was a problem hiding this comment.
Looking good. Only thing that could be improved is that docblocks typically consist of two bits:
title/summary:
First sentence, separated by an empty line from the rest of the text.
description:
The long description.
/**
* The summary of this element.
*
* This is where you would go into more detail...
*/
|
I've separated the long descriptions and left the short descriptions as is. |
DerManoMann
approved these changes
Apr 18, 2023
|
Thanks @MalekMneri |
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.
I added documentation to annotations with No details available and improved a few others.