docs: simplify verbose parameter descriptions in reference docs#12360
Open
nightcityblade wants to merge 1 commit intoaio-libs:masterfrom
Open
docs: simplify verbose parameter descriptions in reference docs#12360nightcityblade wants to merge 1 commit intoaio-libs:masterfrom
nightcityblade wants to merge 1 commit intoaio-libs:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12360 +/- ##
==========================================
+ Coverage 98.77% 98.92% +0.14%
==========================================
Files 128 133 +5
Lines 44890 46550 +1660
Branches 2383 2423 +40
==========================================
+ Hits 44340 46048 +1708
+ Misses 390 373 -17
+ Partials 160 129 -31
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Merging this PR will not alter performance
Comparing 
Footnotes
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #4127
Shorten the
:param:lines in the client and web reference docs and move the detailed explanations into the indented body below each parameter. This follows the maintainer suggestion from the issue and avoids the broken narrow "Parameters" column rendering caused by verbose inline parameter descriptions.