Conversation
Discard unknown directive blocks, including their options and contents, using parser-local states. Preserve following content, known directives, and errors for malformed reStructuredText. Clean docstrings once to retain indentation when a directive appears on the first line. The implementation and tests were generated with OpenAI Codex assistance.
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 #133. Related: #134.
Unknown reStructuredText directives can prevent CLI help and argument conversion from working when they appear in function or parameter-type docstrings. Discard the entire unknown directive block, including its arguments, options, and indented body, while preserving following content and errors for malformed RST.
Use parser-local states for this behavior, including nested parsing, so ordinary Docutils parsers keep their existing unknown-directive errors. Clean docstrings once to preserve indentation when a directive appears on the first line, including subcommand help.
Validated locally: all 169 tests pass with Docutils 0.23 on Python 3.13 and with Docutils 0.12 on Python 3.12; the latter coverage run reports 96%. The HTML documentation build also passes. Tests cover CLI help, constructible parameter types, nested parameter documentation, known directives, and malformed RST.
The implementation and tests were generated with OpenAI Codex assistance.