Skip to content

Correction of two code-blocks python -> pycon after suggestion from #1424 - #1428

Merged
chrysle merged 3 commits into
pypa:mainfrom
LLyaudet:patch-2
Dec 7, 2023
Merged

Correction of two code-blocks python -> pycon after suggestion from #1424#1428
chrysle merged 3 commits into
pypa:mainfrom
LLyaudet:patch-2

Conversation

@LLyaudet

@LLyaudet LLyaudet commented Dec 3, 2023

Copy link
Copy Markdown
Contributor

Hello :),
I just used:

grep -r 'code-block:: python' -A 3 .

in case there was anything else to correct and found another spot.
Best regards,
Laurent Lyaudet


📚 Documentation preview 📚: https://python-packaging-user-guide--1428.org.readthedocs.build/en/1428/

@LLyaudet

LLyaudet commented Dec 3, 2023

Copy link
Copy Markdown
Contributor Author

#1424

@LLyaudet

LLyaudet commented Dec 3, 2023

Copy link
Copy Markdown
Contributor Author

@sinoroc @jeanas I wanted to create an issue to add a warning in the rst parser. I think it would be very easy to find code-blocks with python starting with >>> and output a warning saying it should probably be pycon instead of python. What is the right package to submit this idea ? Is it https://pypi.org/project/docutils/ ?
I will try to improve #1424 first, before looking for that in detail. But if you can help, it would be nice. I think this error may be in many more python projects with rst files.

@jeanas

jeanas commented Dec 3, 2023

Copy link
Copy Markdown
Contributor

It would be either Sphinx, the documentation generator, or Pygments, the syntax highlighter. I've just opened pygments/pygments#2603 on Pygments.

@jeanas

jeanas commented Dec 3, 2023

Copy link
Copy Markdown
Contributor

(Sphinx is built on top of docutils, but syntax highlighting support lives in Sphinx, not in docutils.)

@jeanas

jeanas commented Dec 7, 2023

Copy link
Copy Markdown
Contributor

Anyone to merge this trivial fix?

@chrysle
chrysle enabled auto-merge December 7, 2023 21:25
@chrysle
chrysle added this pull request to the merge queue Dec 7, 2023
Merged via the queue into pypa:main with commit e8a9716 Dec 7, 2023
@LLyaudet

LLyaudet commented Dec 8, 2023

Copy link
Copy Markdown
Contributor Author

Thanks for the validation and the merge :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants