fix(docs): move a few API doc comments to descriptions #15381
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
bencochran
force-pushed
the
api-doc-summary-fixes
branch
from
8a59be6 to
d1e740a
Compare
bencochran
changed the title
alextran1502
approved these changes
Jan 16, 2025
|
Can you run |
|
Yeah, didn’t realize dart docs were downstream of this as well. Fighting environment setup a bit, but I’ll update shortly. |
Previously, the comments were being used as the summaries, and thus were displayed as the “title” of these endpoints
bencochran
force-pushed
the
api-doc-summary-fixes
branch
from
d1e740a to
2db70a8
Compare
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.
Description
Previously, the doc comments were being used as the summaries, and thus were displayed as the “title” of these endpoints in the sidebar. To match the others, I added
@ApiOperation, moving the comments todescriptionand the method name tosummary.Right now, these descriptions are now repeated in the
/** doc comments */and the@ApiOperation. If y’all would prefer to just use@ApiOperationas the way to add method descriptions, happy to make that change too (in which case, we could drop thesummarys here and let those be derived from the method name).How Has This Been Tested?
Screenshots (if appropriate):
Checklist: