mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add items to style guide list

Browse source
This commit is contained in:
Jessica Lord 2015-08-24 15:18:40 -07:00
parent 5018fe1e17
commit f74ce9cc1c
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/styleguide.md
View file

@ -14,13 +14,17 @@ These are the ways that we construct the Electron documentation.
- Hyphen separated filenames, however, are fine. - Hyphen separated filenames, however, are fine.
- No headers following headers, add at least a one-sentence description. - No headers following headers, add at least a one-sentence description.
- Methods headers are wrapped in `code` ticks. - Methods headers are wrapped in `code` ticks.
- Event headers are wrapped in singe 'quotation' marks. - Event headers are wrapped in single 'quotation' marks.
- No nesting lists more than 2 levels (unfortunately because of markdown - No nesting lists more than 2 levels (unfortunately because of markdown
renderer). renderer).
- Add section titles: Events, Class Methods and Instance Methods. - Add section titles: Events, Class Methods and Instance Methods.
- Use 'will' over 'would' when describing outcomes. - Use 'will' over 'would' when describing outcomes.
- Events and methods are `h3` headers. - Events and methods are `h3` headers.
- Optional arguments written as `function (required[, optional])`. - Optional arguments written as `function (required[, optional])`.
- Optional arguments are denoted when called out in list.
- Line length is 80-column wrapped.
- Platform specific methods are noted in italics following method header.
- ```### `method(foo, bar)` _Mac_```
## Reading Electron Documentation ## Reading Electron Documentation