pulsar-edit/pulsar
1
1
Fork 0
mirror of https://github.com/pulsar-edit/pulsar.git synced 2025-01-06 06:28:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update reference syntax in contributing docs

Browse Source
This commit is contained in:
Nathan Sobo 2014-02-20 16:32:26 -07:00
parent 00b913d363
commit 136e7d3491
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -66,8 +66,9 @@ in the proper package's repository.
* Use [TomDoc](http://tomdoc.org).
* Use [Markdown](https://daringfireball.net/projects/markdown).
* Reference classes with `{ClassName}` style notation.
* Reference methods with `{ClassName.methodName}` style notation.
* Reference classes with `{ClassName}`.
* Reference instance methods with `{ClassName::methodName}`.
* Reference class methods with `{ClassName.methodName}`.
* Delegate to comments elsewhere with `{Delegates to: ClassName.methodName}`
style notation.

6
docs/contributing.md
View File

@ -116,8 +116,10 @@ dependencies up to date by running `apm update` after pulling upstream changes.
* Use [TomDoc](http://tomdoc.org).
* Use [Markdown](https://daringfireball.net/projects/markdown).
* Reference classes with the custom `{ClassName}` notation.
* Reference methods with the custom `{ClassName.methodName}` notation.
* Reference methods and classes in markdown with the custom `{}` notation:
* Reference classes with `{ClassName}`
* Reference instance methods with `{ClassName::methodName}`
* Reference class methods with `{ClassName.methodName}`
### Example