← 返回首页
Recommend avoiding `abbr` role · Issue #1824 · python/devguide · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
Resetting focus

Recommend avoiding abbr role #1824

New issue
New issue

Description

Describe the enhancement or feature you would like

We should avoid using the Sphinx abbr role because it is inaccessible on mobile, screen readers, Braille display, and other touch devices.

If you want to use it, spell out in plain text.

For example, instead of:

:abbr:`BMP (Basic Multilingual Plane)`

Use:

Basic Multilingual Plane (BMP)

See python/cpython#150673 (review) for more.

Describe alternatives you have considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    • Open in GitHub Copilot app

    Footer

    © 2026 GitHub, Inc.