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

Use * instead of - for lists

Browse source 
`*` is used in most lists in our docs, let's keep consistency.
This commit is contained in:
Cheng Zhao 2016-07-01 14:30:55 +09:00
parent aee111bf2f
commit 1626c3bf0a
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/styleguide.md
View file

@ -92,13 +92,13 @@ Using `autoUpdater` as an example:
### Classes ### Classes
- API classes or classes that are part of modules must be listed under a * API classes or classes that are part of modules must be listed under a
`## 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 an `### Instance Methods` chapter. * The methods must be listed under an `### Instance Methods` chapter.
- The events must be listed under an `### Instance Events` chapter. * The events must be listed under an `### Instance Events` chapter.
- The properties must be listed under an `### 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:
@ -168,12 +168,12 @@ 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:
- [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) * [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
- [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) * [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
- [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) * [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
- [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) * [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
- [`Boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) * [`Boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
- Or a custom type like Electron's [`WebContent`](api/web-content.md) * Or a custom type like Electron's [`WebContent`](api/web-content.md)
If an argument or a method is unique to certain platforms, those platforms are If an argument or a method is unique to certain platforms, those platforms are
denoted using a space-delimited italicized list following the datatype. Values denoted using a space-delimited italicized list following the datatype. Values