gh-133905: Fix parsing problems in example code#133906
gh-133905: Fix parsing problems in example code#133906cmarqu wants to merge 2 commits intopython:mainfrom
Conversation
sobolevn
left a comment
There was a problem hiding this comment.
Great catch! Thank you!
We should totally add some plugin to parse our examples in the docs.
sobolevn
left a comment
There was a problem hiding this comment.
Looks much better to me! Let's wait for other opinions :)
AA-Turner
left a comment
There was a problem hiding this comment.
I'm not sure about this. Some of these clearly read better to me without the changes in this PR. I'm also hesistant that the motivation here is just to introduce a third party tool, whereas that tool could just be made more resilient.
A
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
|
The sphinx-codeautolink extension is resilient, but it will not put links in these unparseable code snippets. |
| # do something | ||
| ... |
There was a problem hiding this comment.
I would prefer a single line here and for most of the examples. Could do the revision with sed.
| # do something | |
| ... | |
| ... # do something |
There was a problem hiding this comment.
Oops, there was indeed one such occurrence left, fixed. A follow-up PR could reformat all the examples consistently; this PR only works on the places where there were parsing problems.
|
This PR is stale because it has been open for 30 days with no activity. |
Fix problems in documentation example code snippets that prevent them from being parsed.
📚 Documentation preview 📚: https://cpython-previews--133906.org.readthedocs.build/