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

Put optional label before dash

Browse source
This commit is contained in:
Kevin Sawicki 2016-12-29 14:11:26 -08:00
parent 196cb2dda4
commit afa3bd2143
10 changed files with 48 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/styleguide.md
View file

@ -148,8 +148,8 @@ The methods chapter must be in the following form:
```markdown
### `objectName.methodName(required[, optional]))`
* `required` String
* `optional` Integer (optional)
* `required` String - A parameter description.
* `optional` Integer (optional) - Another parameter description.
...
```
@ -187,7 +187,7 @@ denoted using a space-delimited italicized list following the datatype. Values
can be `macOS`, `Windows`, or `Linux`.
```markdown
* `animate` Boolean (optional) _macOS_ _Windows_
* `animate` Boolean (optional) _macOS_ _Windows_ - Animate the thing.
```
`Array` type arguments must specify what elements the array may include in