php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-08-26 06:15:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update the rules for lists (#12389) [skip ci]

Browse Source
This commit is contained in:
Roman Grinyov
2016-09-01 20:38:20 +03:00
committed by Alexander Makarov
parent b3081e53a5
commit 6af1f798ac
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/documentation_style_guide.md
View File

@ -11,13 +11,16 @@ Guidelines to go by when writing or editing any Yii documentation.
* Demonstrate ideas using code as much as possible.
* Never use "we". It's the Yii development team or the Yii core team. Better yet to put things in terms of the framework or the guide.
* Use the Oxford comma (e.g., "this, that, and the other" not "this, that and the other").
* Numeric lists should be complete sentences that end with periods (or other punctuation).
* Bullet lists should be fragments that don't end with periods.
## Formatting
* Use *italics* for emphasis, never capitalization, bold, or underlines.
## Lists
* Numeric lists should be complete sentences that end with periods.
* Bullet lists should be fragments that end with semicolon except the last item, which should end with a period.
## Blocks
Blocks use the Markdown `> Type: `. There are four block types: