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

Added information about highlighting python console examples in doc. #18108

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bmispelon
Copy link
Member

Trac ticket number

N/A

Branch description

I got confused by what the pycon language was in code examples and couldn't find an explanation in our docs. After figuring out it's used for interactive python console examples, I figured I'd mention it somewhere in the contributing docs.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • N/A I have checked the "Has patch" ticket flag in the Trac system.
  • N/A I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • N/A I have attached screenshots in both light and dark modes for any UI changes.

@bmispelon
Copy link
Member Author

If/once pygments/pygments#2697 is merged I would like to propose we switch to a less confusing name for this type of syntax highlighting.

@sarahboyce
Copy link
Contributor

As your PR got merged, perhaps we should switch to that rather than document what pycon means?

@bmispelon
Copy link
Member Author

As your PR got merged, perhaps we should switch to that rather than document what pycon means?

I'm for it, but if I remember correctly @carltongibson was not a big fan.

We'd need to update the dependency on pygments to use the latest release (2.18.0). The search/replace can be done with this unreadable shell script 😅 :

git grep --null --files-with-match --fixed-string ".. code-block:: pycon" -- docs/ | xargs --null sed --in-place --expression='s/.. code-block:: pycon/.. code-block:: python-console/g'

@carltongibson
Copy link
Member

I don't mind if you want to swap. (It's not something I'd do myself, or advocate for, but if you're all keen I'm certainly not going to make a fuss. 🙂)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants