updating the notify API description (#47)

vercel · Jun 17, 2018 · ff0f881 · ff0f881
1 parent 15a1ee7
commit ff0f881
Showing 1 changed file with 12 additions and 3 deletions.
diff --git a/pages/index.js b/pages/index.js
@@ -1345,9 +1345,18 @@ export default class Index extends React.Component {
                       <code>notify</code>
                     </td>
                     <td>
-                      A helper function that shows a desktop notification. The
-                      first parameter is the title and the second is the
-                      optional body of the notification.
+                      <p>
+                        A helper function that shows a desktop notification. The
+                        first parameter is the title, the second is the optional
+                        body of the notification, and the third is another
+                        optional parameter which can be used to log details to
+                        the development console.
+                      </p>
+                      <p>
+                        To pass these details, simply provide and object with an{' '}
+                        <code>error</code> property containing the information
+                        to log.
+                      </p>
                     </td>
                   </tr>
                   <tr>