Browse Source

docs: clarify documentation for getLastCrashReport (#17458)

* docs: clarify documentation for getLastCrashReport

* address feedback
Shelley Vohr 6 years ago
parent
commit
b25279df89
1 changed files with 1 additions and 2 deletions
  1. 1 2
      docs/api/crash-reporter.md

+ 1 - 2
docs/api/crash-reporter.md

@@ -95,8 +95,7 @@ them will get reported without `companyName`, `productName` or any of the `extra
 
 Returns [`CrashReport`](structures/crash-report.md):
 
-Returns the date and ID of the last crash report. If no crash reports have been
-sent or the crash reporter has not been started, `null` is returned.
+Returns the date and ID of the last crash report. Only crash reports that have been uploaded will be returned; even if a crash report is present on disk it will not be returned until it is uploaded. In the case that there are no uploaded reports, `null` is returned.
 
 ### `crashReporter.getUploadedReports()`