style guide update #940
style guide update #940
Conversation
|
Hey thanks for opening this PR. The headline hierarchy still looks broken to me:
Apologies for sending you on a wild goose chase here—I'll buy you a thank coffee if you make it to PyCon next year ;-) It's going to be great to get this sorted out because I suspect this sort inconsistency also makes it harder on readers using accessibility tools like screen readers. So your help is very much appreciated. |
|
No problem, all good. |
|
I think the terminology here is confusing (chapters, pages, sections). What's the difference between a chapter and a page?
I would prefer something like this
Also, maybe add a note like "Note: Each .rst file should start with a Level 1 heading." |
|
You make some valid points, when I first looked at it, I wasn't just sure if the chapter would encompass more pages, that later would be assembled into the chapter, like parts of a page. About the examples, could be anything also, I guess the author was just trying to be funny when he wrote those. Your note suggestion is right on point, I mean, you would think that it is obvious that people should use from top down, and never starting anywhere in the middle. From your note precaution, I think we should also have a similar one for mergers, to check the commit against the style guide before merging. Like a fail safe. I guess we could hear some more thoughts before we do any more changes. |
|
@daniel-demelo @dbader I like his examples the best
|

Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.


So, I update the style guide a little bit.
The headings section more specifically.
No more tilde headings, since it was breaking the rendering.
Sphinx reStructuredText Primer is used as baseline for the headings formats.
I also added a Blank lines section
Hopefully no one will be offended by the changes :)
Otherwise let me know and we can work on it