8000 gh-111895: Convert definition list to bullet list for readability on mobile by hugovk · Pull Request #111898 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-111895: Convert definition list to bullet list for readability on mobile #111898

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

Merged
merged 1 commit into from
Nov 9, 2023

Conversation

hugovk
Copy link
Member
@hugovk hugovk commented Nov 9, 2023

The definition list at https://docs.python.org/3/howto/enum.html#functional-api is very squashed on mobile and hard to read:

Mobile screenshot

image

It doesn't look great on desktop either:

Desktop screenshot

image

Convert it to a bullet list instead:

Mobile screenshot

image

Desktop screenshot

image

Before: https://docs.python.org/3/howto/enum.html#functional-api
After: https://cpython-previews--111898.org.readthedocs.build/en/111898/howto/enum.html#functional-api


📚 Documentation preview 📚: https://cpython-previews--111898.org.readthedocs.build/

@hugovk hugovk requested a review from ethanfurman as a code owner November 9, 2023 15:47
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Nov 9, 2023
@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Nov 9, 2023
@hugovk hugovk merged commit 7d21e3d into python:main Nov 9, 2023
@hugovk hugovk deleted the docs-howto-enum-bullets branch November 9, 2023 18:50
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 9, 2023
…ty on mobile (pythonGH-111898)

Convert definition list to bullet list for readability on mobile
(cherry picked from commit 7d21e3d)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 9, 2023
…ty on mobile (pythonGH-111898)

Convert definition list to bullet list for readability on mobile
(cherry picked from commit 7d21e3d)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@bedevere-app
Copy link
bedevere-app bot commented Nov 9, 2023

GH-111908 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Nov 9, 2023
@bedevere-app
Copy link
bedevere-app bot commented Nov 9, 2023

GH-111909 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Nov 9, 2023
hugovk added a commit that referenced this pull request Nov 9, 2023
…ity on mobile (GH-111898) (#111908)

gh-111895: Convert definition list to bullet list for readability on mobile (GH-111898)

Convert definition list to bullet list for readability on mobile
(cherry picked from commit 7d21e3d)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Nov 9, 2023
…ity on mobile (GH-111898) (#111909)

gh-111895: Convert definition list to bullet list for readability on mobile (GH-111898)

Convert definition list to bullet list for readability on mobile
(cherry picked from commit 7d21e3d)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…ty on mobile (python#111898)

Convert definition list to bullet list for readability on mobile
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
…ty on mobile (python#111898)

Convert definition list to bullet list for readability on mobile
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0