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

use unformatted raw code examples in styleguide

Browse source
This commit is contained in:
Zeke Sikelianos 2016-06-17 12:26:08 -07:00
parent 0d481aaeb8
commit 74e0535659
1 changed files with 7 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/styleguide.md
View file

@ -51,14 +51,12 @@ Here are some tips for understanding Electron documentation syntax.
An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method)
documentation: documentation:
--- ```
`methodName(required[, optional]))` `methodName(required[, optional]))`
* `require` String (**required**) * `required` String (**required**)
* `optional` Integer * `optional` Integer
```
---
The method name is followed by the arguments it takes. Optional arguments are The method name is followed by the arguments it takes. Optional arguments are
notated by brackets surrounding the optional argument as well as the comma notated by brackets surrounding the optional argument as well as the comma
@ -77,15 +75,13 @@ or a custom type like Electron's [`webContent`](api/web-content.md).
An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event)
documentation: documentation:
--- ```
Event: 'wake-up' Event: 'wake-up'
Returns: Returns:
* `time` String * `time` String
```
---
The event is a string that is used after a `.on` listener method. If it returns The event is a string that is used after a `.on` listener method. If it returns
a value it and its type is noted below. If you were to listen and respond to a value it and its type is noted below. If you were to listen and respond to
@ -93,6 +89,6 @@ this event it might look something like this:
```javascript ```javascript
Alarm.on('wake-up', (time) => { Alarm.on('wake-up', (time) => {
console.log(time); console.log(time)
}); })
``` ```