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

Update documentation_style_guide.md

Browse Source 
added style for referencing code objects.
This commit is contained in:
Carsten Brandt
2016-10-06 15:59:40 +02:00
committed by GitHub
parent 89bc2918d3
commit e53cc5e938
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/documentation_style_guide.md
View File

@ -50,6 +50,11 @@ containing the translations. The following shows an example for German:
* Yii 2.0 or Yii 2 (not Yii2 or Yii2.0) * Yii 2.0 or Yii 2 (not Yii2 or Yii2.0)
* Each "page" of the guide is referred to as a "section". * Each "page" of the guide is referred to as a "section".
* References to Code objects:
- Refer to classes using the full namespace: `yii\base\Model`
- Refer to class properties using the static syntax even if they are not static: `yii\base\Model::$validators`
- Refer to class methods using the static syntax even if they are not static and include parenthesis to make it clear, that it is a method: `yii\base\Model::validate()`
- references to code objects should be writting in `[[]]` to generate links to the API documentation. E.g. `[[yii\base\Model]]`, `[[yii\base\Model::$validators]]`, or `[[yii\base\Model::validate()]]`.
## Capitalizations ## Capitalizations