FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Use emoji to illustrate good and bad example commit messages by hugovk · Pull Request #1235 · python/devguide · GitHub

Repository navigation

Use emoji to illustrate good and bad example commit messages - #1235

Merged
hugovk merged 2 commits into
python:mainfrom
hugovk:good-bad
Dec 1, 2023
Merged

hugovk merged 2 commits into
python:mainfrom
hugovk:good-bad

Conversation

hugovk commented Dec 1, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Makes it clear which are the good and bad examples.

✅ Doesn't rely on colour: colour blind people can still see a tick or cross
✅ We don't rely on them: the good/bad meaning is still clear from the text

Details

Details

Compare, for example, the Google developer docs: https://developers.google.com/style/ui-elements

Also fix some formatting.


📚 Documentation preview 📚: https://cpython-devguide--1235.org.readthedocs.build/

hugovk merged commit 9f2b215 into python:main Dec 1, 2023

Copy link
Copy Markdown
Member

PDF builds used to have issues with emojis, and even other Unicode characters.
I don't know if that's still the case and we don't seem to build PDFs for the devguide, so in this case it should be ok.
This is something to keep in mind if you are planning to do similar changes to the cpython docs though.

hugovk deleted the good-bad branch December 3, 2023 20:52

hugovk commented Dec 3, 2023

Copy link
Copy Markdown
Member Author

Good reminder. There's also the epub builds for CPython (but I think they might be broken).

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
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.

3 participants


Back | FazBrowse Home | New Git URL