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

Add documentation for dryrun parameter #2311

Merged
merged 2 commits into from May 13, 2024

Conversation

JackPGreen
Copy link
Contributor

The dryrun paramater's documentation is unhelpful (dryrun mode).

In the absense of proper documentation, this definition from a comment on this topic should be used.

Fixes: #268

The `dryrun` paramater's documentation is unhelpful (`dryrun mode`).

In the absense of proper documentation, [this definition from a comment on this topic](nektos#268 (comment)) should be used.

Fixes: nektos#268
@JackPGreen JackPGreen requested a review from a team as a code owner May 1, 2024 13:06
Copy link

codecov bot commented May 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.49%. Comparing base (5a80a04) to head (afeab1a).
Report is 68 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #2311       +/-   ##
===========================================
+ Coverage   61.56%   76.49%   +14.92%     
===========================================
  Files          53       59        +6     
  Lines        9002     7504     -1498     
===========================================
+ Hits         5542     5740      +198     
+ Misses       3020     1241     -1779     
- Partials      440      523       +83     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

mergify bot commented May 13, 2024

@JackPGreen this pull request has failed checks 🛠

@mergify mergify bot added the needs-work Extra attention is needed label May 13, 2024
@JackPGreen
Copy link
Contributor Author

@JackPGreen this pull request has failed checks 🛠

I can't see anything in the logs that jumps out as a failure. Cynically I don't understand test failures for such a trivial change.

@mergify mergify bot removed the needs-work Extra attention is needed label May 13, 2024
@mergify mergify bot merged commit 070c257 into nektos:master May 13, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document what "dryrun" means for this tool?
2 participants