Use typewriter font for code inside prose
The Endeavour 2013-03-19
There’s a useful tradition of using a typewriter font, or more generally some monospaced font, for bits of code sprinkled in prose. The practice is analogous to using italic to mark, for example, a French mot dropped into an English paragraph. In HTML, the code
tag marks content as software code, which a browser typically will render in a typewriter font.
Here’s a sentence from a new article on Python at Netflix that could benefit a few code
tags.
These features (and more) have led to increasingly pervasive use of Python in everything from small tools using boto to talk to AWS, to storing information with python-memcached and pycassa, managing processes with Envoy, polling restful APIs to large applications with requests, providing web interfaces with CherryPy and Bottle, and crunching data with scipy.
Here’s the same sentence with some code
tags.
These features (and more) have led to increasingly pervasive use of Python in everything from small tools using
boto
to talk to AWS, to storing information withpython-memcached
andpycassa
, managing processes withEnvoy
, polling restful APIs to large applications withrequests
, providing web interfaces withCherryPy
andBottle
, and crunching data withscipy
.
It’s especially helpful to let the reader know that packages like requests
are indeed packages. It helps to clarify, for example, whether Wes McKinney has been stress testing pandas or pandas
. That way we know whether to inform animal protection authorities or to download a new version of a library.