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

Fix #245: Better boolean flag help output #292

Merged
merged 10 commits into from
Dec 8, 2021
Merged

Conversation

tarkatronic
Copy link
Contributor

To help us get this pull request reviewed and merged quickly, please be sure to include the following items:

  • Tests (if applicable)
  • Documentation (if applicable)
  • Changelog entry
  • A full explanation here in the PR description of the work done

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Tests
  • Other

Backward Compatibility

Is this change backward compatible with the most recently released version? Does it introduce changes which might change the user experience in any way? Does it alter the API in any way?

  • Yes (backward compatible)
  • No (breaking changes)

Issue Linking

Fixes #245

What's new?

Using the latest version of click gives us better output for our command line boolean flags. For example:

  --entropy / --no-entropy        Enable entropy checks.  [default: True]

becomes:

  --entropy / --no-entropy        Enable entropy checks.  [default: entropy]

Turns out, there's also a whole ton of other bugfixes and improvements. One of those bugfixes related to path resolution in Windows and resulted in us needing to update some tests. Overall, should be a major positive!

@tarkatronic tarkatronic added this to the Version 3.0 milestone Dec 7, 2021
@tarkatronic tarkatronic requested a review from a team as a code owner December 7, 2021 22:00
@tarkatronic tarkatronic linked an issue Dec 7, 2021 that may be closed by this pull request
@@ -103,9 +103,11 @@ def test_output_dir_is_called_out(
result = runner.invoke(
cli.main, ["--output-dir", "./foo", "scan-local-repo", "."]
)
# Perform a little bit of trickery to make absolutely certain we get a full absolute path
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be a good idea to link the source of inspiration for this bit of trickery?

sushantmimani
sushantmimani previously approved these changes Dec 7, 2021
Copy link
Contributor

@sushantmimani sushantmimani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🦅

@sushantmimani sushantmimani dismissed their stale review December 7, 2021 22:08

CI still failing

Copy link
Contributor

@rbailey-godaddy rbailey-godaddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@sushantmimani sushantmimani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🦅

Copy link
Contributor

@rbailey-godaddy rbailey-godaddy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

even better :)

@tarkatronic tarkatronic merged commit d70097e into v3.x Dec 8, 2021
@tarkatronic tarkatronic deleted the boolean-doc-update branch December 8, 2021 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better defaults for boolean flags
3 participants