Skip to content
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

Recommendations regarding use of backticks in documentation #22

Closed
mdhaber opened this issue Jun 3, 2024 · 0 comments
Closed

Recommendations regarding use of backticks in documentation #22

mdhaber opened this issue Jun 3, 2024 · 0 comments

Comments

@mdhaber
Copy link

mdhaber commented Jun 3, 2024

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.

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

No branches or pull requests

1 participant