From 29bef4e1eec91e1f0d812faeece65946b93c08dc Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Tue, 19 Mar 2019 11:30:48 -0700 Subject: [PATCH 1/2] docs: clarify documentation for getLastCrashReport --- docs/api/crash-reporter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index dcd64a3bbd2ec..79a82f37ffff0 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -96,7 +96,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. +sent (i.e a crash was triggered with `process.crash()` and crash reports are present in the `crashDirectory`, but have not been explicitly uploaded) or the crash reporter has not been started, `null` is returned. ### `crashReporter.getUploadedReports()` From df8aabbc7cffc2c80ba0564712640f42bb00463c Mon Sep 17 00:00:00 2001 From: Shelley Vohr Date: Wed, 20 Mar 2019 10:08:36 -0700 Subject: [PATCH 2/2] address feedback --- docs/api/crash-reporter.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 79a82f37ffff0..c0572269ee58a 100644 --- a/docs/api/crash-reporter.md +++ b/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 (i.e a crash was triggered with `process.crash()` and crash reports are present in the `crashDirectory`, but have not been explicitly uploaded) 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()`