Fix docstring of sphinx.util.parsing.nested_parse_to_nodes(). #13857
+6
−4
Conversation
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
"section" elements can only be children of "document" or "section" elements, not "sidebar". Cf. https://docutils.sourceforge.io/docs/ref/doctree.html#section
|
This is a re-make of my last attempt, fixing a typo in the comment description. |
Add warning about possible data loss with `keep_title_context=True` to `sphinx.utils.parsing.nested_parse_to_nodes()`. Cf. Sphinx issue sphinx-doc#13845.
Since Docutils 0.22, using `sphinx.utils.parsing.nested_parse_to_nodes()` with `keep_title_context=True` no longer leads to data loss. Since Docutils 0.22.1, an error message is reported.
|
Closing because the first commit changes two latin1-encoded files. I always get and then these files are marked as changed in the working dir. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
"section" elements can only be children of "document" or "section" elements, not "sidebar".
Cf. https://docutils.sourceforge.io/docs/ref/doctree.html#section
Purpose
Prevent users of the function from producing invalid documents by giving accurate information.
References