Consistent use of monospaced font #1852
Labels
needs: discussion
Needs discussion before an implementation can be made
tag: design
Items related to design tasks or improvements
I think it would be helpful if code tokens were consistently rendered in monospaced font. For instance, in the documentation of
scipy.stats.bootstrap
, text that refers to code is rendered in many different styles.scipy.stats
table of contents mixes monospaced and proportional font in the function signature:scipy.stats.bootstrap
page, the title heading uses proportional font:(Although this situation may be improved by numpy/numpydoc#525 and linked issues.)
(Please feel free to add other ways that code appears. I think that the numbers will help us refer to distinct cases as needed.)
This issue could be generalized to be about consistent use of color, boldface, italics, etc..., but I thought it would be best to be a little more targeted here. So my suggestion is that that appearances of code should either all be monospaced or all proportional. My initial motivation is from the perspective of consistency and aesthetics, but I think there is also an accessibility perspective to be considered. Personally, I think that monospacing is a helpful visual cue to distinguish code from other text, so I would prefer that all code be monospaced, but I recognize that there may be arguments in the other direction.
The text was updated successfully, but these errors were encountered: