Skip to content
This repository was archived by the owner on Mar 14, 2018. It is now read-only.

Commit e53cc5e

Browse files
authored
Update documentation_style_guide.md
added style for referencing code objects.
1 parent 89bc291 commit e53cc5e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Diff for: docs/documentation_style_guide.md

+5
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ containing the translations. The following shows an example for German:
5050

5151
* Yii 2.0 or Yii 2 (not Yii2 or Yii2.0)
5252
* Each "page" of the guide is referred to as a "section".
53+
* References to Code objects:
54+
- Refer to classes using the full namespace: `yii\base\Model`
55+
- Refer to class properties using the static syntax even if they are not static: `yii\base\Model::$validators`
56+
- 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()`
57+
- 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()]]`.
5358

5459
## Capitalizations
5560

0 commit comments

Comments
 (0)