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
DOC: Refine --reckless docstring on usage and wording #6043
Conversation
Codecov Report
@@ Coverage Diff @@
## maint #6043 +/- ##
==========================================
- Coverage 90.27% 87.91% -2.37%
==========================================
Files 312 312
Lines 42157 42189 +32
==========================================
- Hits 38058 37091 -967
- Misses 4099 5098 +999
Continue to review full report at Codecov.
|
first I got confused with CI fails, but it is for "Branch" (not PR; and since PR is from a branch in this repo instead of a fork) so the base for this PR is a bit outdated (without fixes) |
Will rebase, one second. |
This is an attempt to fix #6039, in which a user's confusion over the --reckless parameter could be traced to a lack of clarity about the fact that this parameter is meant to be used at cloning. Therefore, this change adds concrete examples and more refined wording to the parameter docstring. This change also removes a rather patronizing statement completely.
Test failures are an intermittent fluke for codecov submission. No actual test failures. |
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
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.
Let's see what the test will do. I left one more suggestion for an incremental improvement.
Co-authored-by: Michael Hanke <michael.hanke@gmail.com>
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.
Thx!
This is an attempt to fix #6039, in which a user's confusion over the
--reckless
parameter could be traced to a lack of clarityabout the fact that this parameter is meant to be used at cloning.
Therefore, this change adds concrete examples and more refined wording
to the parameter docstring.
This change also removes a rather patronizing statement completely.