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

minor wording changes and tweaks

Browse source
This commit is contained in:
Zeke Sikelianos 2016-06-24 15:59:30 -07:00 • committed by GitHub
parent 63e2ee8e10
commit aee111bf2f
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/styleguide.md
View file

@ -6,7 +6,7 @@ These are the guidelines for writing Electron documentation.
* Each page must have a single `#`-level title at the top. * Each page must have a single `#`-level title at the top.
* Chapters in the same page must have `##`-level titles. * Chapters in the same page must have `##`-level titles.
* Sub-chapters need to increase the number of `#` in the title according to its * Sub-chapters need to increase the number of `#` in the title according to their
nesting depth. nesting depth.
* All words in the page's title must be capitalized. * All words in the page's title must be capitalized.
* Only the first word of a chapter title must be capitalized. * Only the first word of a chapter title must be capitalized.
@ -69,7 +69,6 @@ Using `session` as example:
# session # session
> Manage browser sessions, cookies, cache, proxy settings, etc. > Manage browser sessions, cookies, cache, proxy settings, etc.
``` ```
### Module methods and events ### Module methods and events
@ -97,9 +96,9 @@ Using `autoUpdater` as an example:
`## Class: TheClassName` chapter. `## Class: TheClassName` chapter.
- One page can have multiple classes. - One page can have multiple classes.
- The constructors must be listed with `###`-level titles. - The constructors must be listed with `###`-level titles.
- The methods must be listed under a `### Instance Methods` chapter. - The methods must be listed under an `### Instance Methods` chapter.
- The events must be listed under a `### Instance Events` chapter. - The events must be listed under an `### Instance Events` chapter.
- The properties must be listed under a `Instance Properties` chapter. - The properties must be listed under an `### Instance Properties` chapter.
Using the `Session` and `Cookies` classes as an example: Using the `Session` and `Cookies` classes as an example:
@ -146,22 +145,25 @@ The methods chapter must be in the following form:
* `optional` Integer (optional) * `optional` Integer (optional)
... ...
``` ```
The title can be `###` or `####`-levels depending on whether it is a method of The title can be `###` or `####`-levels depending on whether it is a method of
a module or a class. a module or a class.
For modules, the `objectName` is the module's name, for classes, it must be the For modules, the `objectName` is the module's name. For classes, it must be the
name of the instance of the class, and must not be the same as the module's name of the instance of the class, and must not be the same as the module's
name. name.
For example, the methods of the `Session` class under the `session` module must For example, the methods of the `Session` class under the `session` module must
use `ses` as the `objectName`. use `ses` as the `objectName`.
The optional arguments are notated by brackets surrounding the optional argument The optional arguments are notated by square brackets `[]` surrounding the optional argument
as well as the comma required if this optional argument follows another as well as the comma required if this optional argument follows another
argument. argument:
```
required[, optional]
```
Below the method is more detailed information on each of the arguments. The type Below the method is more detailed information on each of the arguments. The type
of argument is notated by either the common types: of argument is notated by either the common types:
@ -181,7 +183,7 @@ can be `macOS`, `Windows`, or `Linux`.
* `animate` Boolean (optional) _macOS_ _Windows_ * `animate` Boolean (optional) _macOS_ _Windows_
``` ```
`Array` type arguments must be classified what elements the array may include in `Array` type arguments must specify what elements the array may include in
the description below. the description below.
The description for `Function` type arguments should make it clear how it may be The description for `Function` type arguments should make it clear how it may be
@ -199,7 +201,6 @@ Returns:
* `time` String * `time` String
... ...
``` ```
The title can be `###` or `####`-levels depending on whether it is an event of The title can be `###` or `####`-levels depending on whether it is an event of
@ -215,7 +216,6 @@ The properties chapter must be in following form:
### session.defaultSession ### session.defaultSession
... ...
``` ```
The title can be `###` or `####`-levels depending on whether it is a property of The title can be `###` or `####`-levels depending on whether it is a property of