List punctuation in crash-reporter

This commit is contained in:
Jessica Lord 2015-08-25 05:18:02 -07:00
parent 2c7ccffe1a
commit d2288815f8

View file

@ -22,13 +22,13 @@ The `crash-reporter` module has the following methods:
### `crashReporter.start(options)` ### `crashReporter.start(options)`
* `options` Object * `options` Object
* `productName` String, default: Electron * `productName` String, default: Electron.
* `companyName` String, default: GitHub, Inc * `companyName` String, default: GitHub, Inc.
* `submitUrl` String, default: http://54.249.141.255:1127/post * `submitUrl` String, default: http://54.249.141.255:1127/post.
* URL that crash reports will be sent to as POST * URL that crash reports will be sent to as POST.
* `autoSubmit` Boolean, default: true * `autoSubmit` Boolean, default: `true`.
* Send the crash report without user interaction * Send the crash report without user interaction.
* `ignoreSystemCrashHandler` Boolean, default: false * `ignoreSystemCrashHandler` Boolean, default: `false`.
* `extra` Object * `extra` Object
* An object you can define that will be sent along with the report. * An object you can define that will be sent along with the report.
* Only string properties are sent correctly. * Only string properties are sent correctly.
@ -56,17 +56,17 @@ Returns all uploaded crash reports. Each report contains the date and uploaded I
The crash reporter will send the following data to the `submitUrl` as `POST`: The crash reporter will send the following data to the `submitUrl` as `POST`:
* `rept` String - e.g. 'electron-crash-service' * `rept` String - e.g. 'electron-crash-service'.
* `ver` String - The version of Electron * `ver` String - The version of Electron.
* `platform` String - e.g. 'win32' * `platform` String - e.g. 'win32'.
* `process_type` String - e.g. 'renderer' * `process_type` String - e.g. 'renderer'.
* `ptime` Number * `ptime` Number
* `_version` String - The version in `package.json` * `_version` String - The version in `package.json`.
* `_productName` String - The product name in the `crashReporter` `options` * `_productName` String - The product name in the `crashReporter` `options`
object object.
* `prod` String - Name of the underlying product. In this case Electron * `prod` String - Name of the underlying product. In this case Electron.
* `_companyName` String - The company name in the `crashReporter` `options` * `_companyName` String - The company name in the `crashReporter` `options`
object object.
* `upload_file_minidump` File - The crashreport as file * `upload_file_minidump` File - The crash report as file.
* All level one properties of the `extra` object in the `crashReporter` * All level one properties of the `extra` object in the `crashReporter`.
`options` object `options` object