use unformatted raw code examples in styleguide
authorZeke Sikelianos <zeke@sikelianos.com>
Fri, 17 Jun 2016 19:26:08 +0000 (12:26 -0700)
committerZeke Sikelianos <zeke@sikelianos.com>
Wed, 22 Jun 2016 05:54:43 +0000 (22:54 -0700)
docs/styleguide.md

index 44afe2a..c388b31 100644 (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)
 documentation:
 
----
-
+```
 `methodName(required[, optional]))`
 
-* `require` String (**required**)
+* `required` String (**required**)
 * `optional` Integer
-
----
+```
 
 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
@@ -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)
 documentation:
 
----
-
+```
 Event: 'wake-up'
 
 Returns:
 
 * `time` String
-
----
+```
 
 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
@@ -93,6 +89,6 @@ this event it might look something like this:
 
 ```javascript
 Alarm.on('wake-up', (time) => {
-  console.log(time);
-});
+  console.log(time)
+})
 ```