documentation-style-guide-sphinx icon indicating copy to clipboard operation
documentation-style-guide-sphinx copied to clipboard

Published 20 hours ago • verified publisher icon benoitbryon

Check PEP 12

Open benoitbryon opened this issue 13 years ago • 1 comments

There are some RST conventions in PEP 12. Adopt some of them? or ask the PEP author to adoptt the conventions here?

benoitbryon avatar Jun 19 '12 06:06 benoitbryon

Some conventions seen in PEP 12:

  • 4 spaces indentation for literal blocks
  • "references" section at the end of the document
  • "copyright" section at the end of the document
  • line length of 70 characters
  • header with fields
  • several H1

benoitbryon avatar Jun 19 '12 06:06 benoitbryon