New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: clarify documentation for getLastCrashReport #17458
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a pretty harsh rename that serves no purpose other than to help explain what the method does slightly better.
Can we at a minimum deprecate this so that it still works in the next major and preferably just support both Forever ™️ . It's not like adding getLastCrashReport() { return this. getLastUploadedCrashReport() }
is going to be much of a maintenance burden 👍
hmm, i agree; if we think that just being really explicit in the documentation would address the same root problem then i'm happy with that tbqh what do you think @MarshallOfSound? |
@codebytere Adding explicit docs would be way better for both newcomers to the API and reducing the churn on existing users 👍 |
3af912e
to
877135d
Compare
@MarshallOfSound updated! |
Release Notes Persisted
|
I have automatically backported this PR to "5-0-x", please check out #17493 |
I have automatically backported this PR to "4-1-x", please check out #17494 |
* docs: clarify documentation for getLastCrashReport * address feedback
Description of Change
Resolves #17399.
At present, it's not clear that
getLastCrashReport
only returns crash reports that have been uploaded, and so this PR add clarifying information to documentation.Checklist
npm test
passesRelease Notes
Notes: Clarified usage of
crashReporter.getLastCrashReport()
in documentation.