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.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial documentation for doc comment references #6080
Initial documentation for doc comment references #6080
Changes from 13 commits
2acef88
75d38b5
9a48173
5ff3658
2c3c897
56f7299
2e87da2
ea456a4
677de9e
478d7c7
a10d1fb
092a2a9
1d7bfb2
dfe246d
5d89b66
11b6937
34b124e
3037c83
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this section is useful but it's a bit long and will potentially be skipped over.
Could we perhaps add another (complementary) section with a quick-reference table or list? I'm happy to help experiment with some options for doing so if you think it'd be helpful. I imagine it related each type of member with an example of its doc comment reference syntax. Many can likely be grouped together as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great idea, I've started an attempt at this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for exploring this! It seems a bit cramped with the table formatting, so maybe let's drop the table for now. I can revisit this with some different formats or custom styles as follow up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SG. I'm sure there's a good solution in here. Maybe just experiment with different table layouts.