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 example invocation with tags in help string #254

Merged
merged 1 commit into from
Nov 15, 2022

Conversation

mmtj
Copy link
Contributor

@mmtj mmtj commented Oct 25, 2022

This PR updates the help string for example with tags - use valid and currently available tags.

I am not that familiar with all tags and regexes, so it is quite possible that provided example does not necessary shows the best capabilities of pyWhat. I was aiming to alter the example to provide at least some match, instead of warning about incorrect invocation.

So feel free to suggest more meaningful example :-)

⚠ Pull Requests not made with this template will be automatically closed 🔥

Prerequisites

Why do we need this pull request?

  • Example invocation should lead to at least some result, so user might get familiar with intended usage. IMO it should not show warning about incorrect invocation.

What GitHub issues does this fix?

Copy / paste of output

Please copy and paste the output of PyWhat with your new addition using an example that tests this addition below:

$ what --rarity 0: --include "credentials" --exclude "aws" 'James:SecretPassword'
Matched on: James:SecretPassword
Name: Key:Value Pair

Closes: bee-san#253

Signed-off-by: Martin Matějek <martin.matejek@gmx.com>
@bee-san
Copy link
Owner

bee-san commented Nov 15, 2022

Thanks so much!!

@bee-san bee-san merged commit 8a83d28 into bee-san:main Nov 15, 2022
@bee-san
Copy link
Owner

bee-san commented Nov 15, 2022

Thanks so much!!

@mmtj
Copy link
Contributor Author

mmtj commented Nov 17, 2022

You are welcome, I'm glad I could help :-)

@mmtj mmtj deleted the fix/help-example-with-tags branch October 30, 2023 22:51
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.

Passed tags are not valid for example invocation from --help string
2 participants