Minor updates to crash reporter notes
authorKevin Sawicki <kevin@github.com>
Mon, 28 Nov 2016 23:37:06 +0000 (15:37 -0800)
committerGitHub <noreply@github.com>
Mon, 28 Nov 2016 23:37:06 +0000 (15:37 -0800)
docs/api/crash-reporter.md

index 9925f76..338c890 100644 (file)
@@ -47,17 +47,17 @@ The `crashReporter` module has the following methods:
     report. Only string properties are sent correctly, Nested objects are not
     supported.
 
-You are required to call this method before using other `crashReporter` APIs
+You are required to call this method before using any other `crashReporter` APIs
 and in each process (main/renderer) from which you want to collect crash reports.
-You can pass different options to `crashReporter.start` while calling from different processes.
+You can pass different options to `crashReporter.start` when calling from different processes.
 
 **Note:** On Windows and Linux, Electron uses `breakpad` for crash collection and reporting.
 Crashes can be collected from the main and renderer process, but not from the child processes 
-created via `child_process` module.
+created via the `child_process` module.
 
 **Note:** On macOS, Electron uses a new `crashpad` client for crash collection and reporting.
 Crashes can be collected from the main, renderer and any of the child processes created via the `child_process` module.
-If you want to enable crash reporting, initializing `crashpad` from the main process using `crashReporter.start` is mandatory 
+If you want to enable crash reporting, initializing `crashpad` from the main process using `crashReporter.start` is required 
 regardless of which process you want to collect crashes from. Once initialized this way, the crashpad handler collects
 crashes from all processes. You still have to call `crashReporter.start` from the renderer process, otherwise crashes from
 renderer processes will get reported without `companyName`, `productName` or any of the `extra` information.