Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 3 commits into from
Dec 7, 2023

Conversation

LLyaudet
Copy link
Contributor

@LLyaudet LLyaudet commented Dec 3, 2023

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
Copy link
Contributor Author

LLyaudet commented Dec 3, 2023

#1424

@LLyaudet
Copy link
Contributor Author

LLyaudet commented Dec 3, 2023

@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
Copy link
Contributor

jeanas commented Dec 3, 2023

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

@jeanas
Copy link
Contributor

jeanas commented Dec 3, 2023

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

@jeanas
Copy link
Contributor

jeanas commented Dec 7, 2023

Anyone to merge this trivial fix?

@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
5 checks passed
@LLyaudet
Copy link
Contributor Author

LLyaudet commented Dec 8, 2023

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