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.

Sign up for GitHub

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

Jump to bottom

Add details to error reporting flag in help message #367

Closed
eliecharra opened this issue Mar 26, 2021 · 2 comments
Closed

Add details to error reporting flag in help message #367

eliecharra opened this issue Mar 26, 2021 · 2 comments
Assignees
@sjourdan
Labels
kind/documentation Improvements or additions to documentation
Milestone
v0.7.1

Comments

@eliecharra
Copy link
Contributor

Description
The error reporting flag seems to be confusing.
We need to make it clear that is sends some data to out Sentry server.
@eliecharra eliecharra added the kind/documentation Improvements or additions to documentation label Mar 26, 2021
@eliecharra eliecharra added this to the v0.7.1 milestone Mar 26, 2021
@lotoussa lotoussa mentioned this issue Mar 26, 2021
Merged
@sundowndev sundowndev assigned sjourdan and unassigned lotoussa Apr 7, 2021
@lotoussa lotoussa mentioned this issue Apr 12, 2021
Merged
@sjourdan
Copy link
Contributor

Can we have a quick grammar fix?

from

      --send-crash-report   Enable error reporting. Crash data will be sent to us via Sentry.
                            WARNING: may leak sensitive data (please read documentation for more details)
                            This flag should be used only if an error occur during execution

to

      --send-crash-report   Enable error reporting. Crash data will be sent to us via Sentry.
                            WARNING: may leak sensitive data (please read the documentation for more details)
                            This flag should be used only if an error occurred during execution

@lotoussa lotoussa mentioned this issue Apr 12, 2021
Merged
@sjourdan
Copy link
Contributor

LGTM (using present tense as discussed on discord)

      --send-crash-report   Enable error reporting. Crash data will be sent to us via Sentry.
                            WARNING: may leak sensitive data (please read the documentation for more details)
                            This flag should be used only if an error occurs during execution

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sjourdan sjourdan

Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.7.1
Development

No branches or pull requests
3 participants
@sjourdan @eliecharra @lotoussa