Fix formatting of AV::TestCase.register_parser doc [ci-skip]
#49924
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
This fixes a few issues with the formatting of the API documentation for `ActionView::TestCase::Behavior::ClassMethods#register_parser`: * Use `h4` headings instead of `h3` headings. SDoc renders method signatures as `h3` headings, so subheadings such as "Examples" should use `h4`. * Replace "Arguments" heading with "Parameters". "Parameters" are elements of function's signature, whereas "arguments" are elements of a function call. The API documentation for other methods follows this convention. * Format parameters as term list. * Fix indentation of pre-registered parser lists to render them as lists instead of as code. * Miscellaneous rewording, reorganization, and additional monospace formatting.
jonathanhefner
added a commit
that referenced
this pull request
Nov 5, 2023
…rser-doc-formatting Fix formatting of `AV::TestCase.register_parser` doc [ci-skip] (cherry picked from commit 8a304dc)
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.
This fixes a few issues with the formatting of the API documentation for
ActionView::TestCase::Behavior::ClassMethods#register_parser:Use
h4headings instead ofh3headings. SDoc renders method signatures ash3headings, so subheadings such as "Examples" should useh4.Replace "Arguments" heading with "Parameters". "Parameters" are elements of function's signature, whereas "arguments" are elements of a function call. The API documentation for other methods follows this convention.
Format parameters as term list.
Fix indentation of pre-registered parser lists to render them as lists instead of as code.
Miscellaneous rewording, reorganization, and additional monospace formatting.