darglint2
darglint2 copied to clipboard
Consistent formatting in docs and README.
Eventually I'd prefer monospace
to be used in most places where italics is now used – at least for directory paths and file names, command lines and format string attributes.
Current documentation is a mixture of monospace and italics.
The above applies to the change log.
But it's probably best to do this improvement in a separate issue and PR.
Originally posted by @akaihola in https://github.com/akaihola/darglint2/pull/33#discussion_r1199817934
Lets use italics for
- names (of people, projects, ...)
- technical terms when they are introduced (e.g. when explaining the term 'complain')
- maybe instead of quoting in cases like the above?
Lets use monospace
for
- paths
- file/directory names
- command lines, command line arguments
- config options
- complaint codes
- code snippets
- code elements like function names, format string attributes, ...
This one is mechanical enough that I could contribute the PR.
This one is mechanical enough that I could contribute the PR.
As you wish. However I would find it more valuable if you wrote the texts for #3.
more valuable if you wrote the texts for #3
Fair enough, I'll focus on that first!