darglint2 icon indicating copy to clipboard operation
darglint2 copied to clipboard

Consistent formatting in docs and README.

Open real-yfprojects opened this issue 1 year ago • 4 comments

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

real-yfprojects avatar May 22 '23 10:05 real-yfprojects

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, ...

real-yfprojects avatar May 28 '23 08:05 real-yfprojects

This one is mechanical enough that I could contribute the PR.

akaihola avatar May 28 '23 08:05 akaihola

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.

real-yfprojects avatar May 28 '23 08:05 real-yfprojects

more valuable if you wrote the texts for #3

Fair enough, I'll focus on that first!

akaihola avatar May 28 '23 09:05 akaihola