Skip to content

Recommendations regarding use of backticks in documentation #22

@mdhaber

Description

@mdhaber

I believe that given token of code should by stylized consistently throughout documentation to help the reader recognize the token amidst plain text. In many projects, this is not the case; for instance, in the documentation of scipy.stats.bootstrap, data appears as:

bold, monospaced, italicized with background
image

italicized
image

bold
image

pink, monospaced with gray background
image

Before noon on 6/3, I'd like to focus on resolving one source of these inconsistencies: numpy/numpydoc#525.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

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