sphinxdocs: fix rendering of args in directives with empty doc#2313
Merged
rickeylev merged 1 commit intobazel-contrib:mainfrom Oct 18, 2024
Merged
Conversation
aignas
approved these changes
Oct 18, 2024
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
2 participants
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 bug where tag-classes/functions that didn't have a doc string, but did
have arguments/attributes, would render the args/attrs immediately after the directive
line, which made them get interpreter as direction options (settings that apply to
the overall directive) instead of doc fields nested within the directive (separate
block-level elements that get rendered).
To fix, update the code to ensure there's a newline between the directive line and
subsequent arg/attr lines. Also adds tests for this.