[docs] Fix Deprecated annotation indentation #31532
Merged
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.
Signed-off-by: Kai Fricke kai@anyscale.com
Why are these changes needed?
Our Documentation build job currently returns errors like this:
The reason for this is the
Deprecated
annotation that adds awarning
block to the__doc__
property to be rendered in our documentation.The code is faulty: A misplaced newline character in the
DEPRECATED
message block removes the proper indentation:Additionally, newline characters in the deprecation message are also not indented correctly:
This PR fixes both problems:
Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.