Skip to content
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

Merged
merged 2 commits into from Mar 20, 2019

Conversation

codebytere
Copy link
Member

@codebytere codebytere commented Mar 19, 2019

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

Release Notes

Notes: Clarified usage of crashReporter.getLastCrashReport() in documentation.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Mar 19, 2019
@codebytere codebytere added the semver/major incompatible API changes label Mar 19, 2019
Copy link
Member

@MarshallOfSound MarshallOfSound left a 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 👍

@codebytere
Copy link
Member Author

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?

@MarshallOfSound
Copy link
Member

@codebytere Adding explicit docs would be way better for both newcomers to the API and reducing the churn on existing users 👍

@codebytere codebytere changed the title refactor: rename getLastCrashReport => getLastUploadedCrashReport refactor: clarify documentation for getLastCrashReport Mar 19, 2019
@codebytere codebytere changed the title refactor: clarify documentation for getLastCrashReport docs: clarify documentation for getLastCrashReport Mar 19, 2019
@codebytere codebytere force-pushed the clarify-crash-report-uploaded branch from 3af912e to 877135d Compare March 19, 2019 20:12
@codebytere
Copy link
Member Author

@MarshallOfSound updated!

@codebytere codebytere added documentation 📓 and removed semver/major incompatible API changes labels Mar 19, 2019
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Mar 20, 2019
@codebytere codebytere merged commit b25279d into master Mar 20, 2019
@release-clerk
Copy link

release-clerk bot commented Mar 20, 2019

Release Notes Persisted

Clarified usage of crashReporter.getLastCrashReport() in documentation.

@codebytere codebytere deleted the clarify-crash-report-uploaded branch March 20, 2019 22:34
@trop
Copy link
Contributor

trop bot commented Mar 20, 2019

I have automatically backported this PR to "5-0-x", please check out #17493

@trop
Copy link
Contributor

trop bot commented Mar 20, 2019

I have automatically backported this PR to "4-1-x", please check out #17494

@sofianguy sofianguy added this to Fixed in 5.0.0-beta.7 in 5.0.x Mar 28, 2019
kiku-jw pushed a commit to kiku-jw/electron that referenced this pull request May 16, 2019
* docs: clarify documentation for getLastCrashReport

* address feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
5.0.x
Fixed in 5.0.0-beta.7
Development

Successfully merging this pull request may close these issues.

None yet

2 participants