KBach added a comment.
Added changes intended to unify the usage of headline syntax in the docs. The
rules I tried to apply are:
- Every index page should use the headline syntax in the following order:
1. `#` with overline
2. `*` with overline
3. `=`
4. `-`
5. `^`
6. `"`
- Every other page should use the headline syntax in the following order
(essentially the same, but without `#`):
1. `*` with overline
2. `=`
3. `-`
4. `^`
5. `"`
I think this is relatively simple and should be easy to pick up for new
contributors. This order is also consistent with Python Developer Guidelines
<https://devguide.python.org/documentation/markup/#sections>, though it does
not assign specific purpose (e.g. part, chapter, section, etc.) to each level.
The current patch does not apply these changes to the docs/tests_ref folder
(apart from its index.rst file). I'll add this if this change gets positive
feedback.
TASK DETAIL
https://phabricator.wikimedia.org/T323812
EMAIL PREFERENCES
https://phabricator.wikimedia.org/settings/panel/emailpreferences/
To: KBach
Cc: whym, pywikibot-bugs-list, Aklapper, binbot, Xqt, Dvorapa, KBach, Adamm71,
Jersione, Hellket777, LisafBia6531, 786, Biggs657, Maberdour, PotsdamLamb,
Jyoo1011, JohnsonLee01, Juan90264, SHEKH, Dijkstra, Alter-paule, Beast1978,
Un1tY, Khutuck, Zkhalido, Demian, Hook696, Pavithraes, Kent7301, Urstrulykkr,
joker88john, Viztor, CucyNoiD, Wenyi, Gaboe420, Giuliamocci, Cpaulf30, Af420,
Bsandipan, Jayprakash12345, Tbscho, srishakatux, MayS, Lewizho99, Mdupont,
JJMC89, Maathavan, Altostratus, Neuronton, Avicennasis, mys_721tx, Gryllida,
jayvdb, Masti, Alchimista, Rfarrand, bd808, jeremyb
_______________________________________________
pywikibot-bugs mailing list -- [email protected]
To unsubscribe send an email to [email protected]
