Skip to content

Recommend avoiding abbr role #1824

@hugovk

Description

@hugovk

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