Rewrite the "Docutils markup API" page #12505
Merged
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
chrisjsewell
requested changes
Jul 2, 2024
chrisjsewell
reviewed
Jul 2, 2024
chrisjsewell
reviewed
Jul 2, 2024
chrisjsewell
reviewed
Jul 3, 2024
doc/extdev/markupapi.rst
Outdated
| Docutils represents document source lines in a class | ||
| ``docutils.statemachine.ViewList``. This is a list with extended functionality | ||
| -- for one, slicing creates views of the original list, and also the list | ||
| contains information about the source line numbers. |
There was a problem hiding this comment.
Here's a fun fact for you; the docutils parser (incorrectly IMO) uses the offset into the StringList, rather than the actual source line you assign to the line, to report most warnings, making the source information kind of meaningless 😒
AA-Turner
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
See #12492.
A