Skip to content

Commit aee111b

Browse files
authored
minor wording changes and tweaks
1 parent 63e2ee8 commit aee111b

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/styleguide.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ These are the guidelines for writing Electron documentation.
66

77
* Each page must have a single `#`-level title at the top.
88
* Chapters in the same page must have `##`-level titles.
9-
* Sub-chapters need to increase the number of `#` in the title according to its
9+
* Sub-chapters need to increase the number of `#` in the title according to their
1010
nesting depth.
1111
* All words in the page's title must be capitalized.
1212
* Only the first word of a chapter title must be capitalized.
@@ -69,7 +69,6 @@ Using `session` as example:
6969
# session
7070

7171
> Manage browser sessions, cookies, cache, proxy settings, etc.
72-
7372
```
7473

7574
### Module methods and events
@@ -97,9 +96,9 @@ Using `autoUpdater` as an example:
9796
`## Class: TheClassName` chapter.
9897
- One page can have multiple classes.
9998
- The constructors must be listed with `###`-level titles.
100-
- The methods must be listed under a `### Instance Methods` chapter.
101-
- The events must be listed under a `### Instance Events` chapter.
102-
- The properties must be listed under a `Instance Properties` chapter.
99+
- The methods must be listed under an `### Instance Methods` chapter.
100+
- The events must be listed under an `### Instance Events` chapter.
101+
- The properties must be listed under an `### Instance Properties` chapter.
103102

104103
Using the `Session` and `Cookies` classes as an example:
105104

@@ -146,22 +145,25 @@ The methods chapter must be in the following form:
146145
* `optional` Integer (optional)
147146

148147
...
149-
150148
```
151149

152150
The title can be `###` or `####`-levels depending on whether it is a method of
153151
a module or a class.
154152

155-
For modules, the `objectName` is the module's name, for classes, it must be the
153+
For modules, the `objectName` is the module's name. For classes, it must be the
156154
name of the instance of the class, and must not be the same as the module's
157155
name.
158156

159157
For example, the methods of the `Session` class under the `session` module must
160158
use `ses` as the `objectName`.
161159

162-
The optional arguments are notated by brackets surrounding the optional argument
160+
The optional arguments are notated by square brackets `[]` surrounding the optional argument
163161
as well as the comma required if this optional argument follows another
164-
argument.
162+
argument:
163+
164+
```
165+
required[, optional]
166+
```
165167

166168
Below the method is more detailed information on each of the arguments. The type
167169
of argument is notated by either the common types:
@@ -181,7 +183,7 @@ can be `macOS`, `Windows`, or `Linux`.
181183
* `animate` Boolean (optional) _macOS_ _Windows_
182184
```
183185

184-
`Array` type arguments must be classified what elements the array may include in
186+
`Array` type arguments must specify what elements the array may include in
185187
the description below.
186188

187189
The description for `Function` type arguments should make it clear how it may be
@@ -199,7 +201,6 @@ Returns:
199201
* `time` String
200202

201203
...
202-
203204
```
204205

205206
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:
215216
### session.defaultSession
216217

217218
...
218-
219219
```
220220

221221
The title can be `###` or `####`-levels depending on whether it is a property of

0 commit comments

Comments
 (0)