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

Update Command Line Options #751

Merged
merged 3 commits into from
Sep 7, 2020
Merged

Update Command Line Options #751

merged 3 commits into from
Sep 7, 2020

Conversation

hoadlck
Copy link
Contributor

@hoadlck hoadlck commented Sep 7, 2020

Restore --print-found option.

Now --print-all and --print-found complement each other. The default remains that only the found are reported.

Update documentation on timeout command line option.

Now --print-all and --print-found complement each other.  The default remains that only the found are reported.
@hoadlck hoadlck added the enhancement New feature or request label Sep 7, 2020
@hoadlck hoadlck merged commit 413bdb2 into master Sep 7, 2020
@sdushantha
Copy link
Member

Now --print-all and --print-found complement each other

There must be something that I'm not understanding here. 🤔
If I were to use --print-all followed by --print-found when running Sherlock, wouldn't that result in the default behavior?
So what is the purpose of having --print-found if the default behavior of Sherlock is to only show the found sites?

@hoadlck
Copy link
Contributor Author

hoadlck commented Sep 7, 2020

The --print-found option was originally in Sherlock, so it should continue to be included. That was the reason for the addition.

In general for command line tools that effect booleans, there is an option to turn it on and an option to turn it off. The default changes (as it changed in this case).

@sdushantha
Copy link
Member

The --print-found option was originally in Sherlock, so it should continue to be included. That was the reason for the addition.

I personally think this is the same as saying "the ascii banner was originally in Sherlock, so it should continue to be included". We have made changes to Sherlock in the past where we have removed certain things that were initially a part of Sherlock. I don't see why something should stay just because it has always been there. I know change is a little difficult to get used to but change in general (if positive) is good.

In general for command line tools that effect booleans, there is an option to turn it on and an option to turn it off. The default changes (as it changed in this case).

I agree with you there but could you provide an example of when someone would use --print-found? I just find it to be redundant since --print-found is the default behavior.

@hoadlck
Copy link
Contributor Author

hoadlck commented Sep 8, 2020

The command line options are not cosmetic: they effect the function of the program. So, they are nothing like the ASCII banner. Value added change is fine, but churn for little value just breaks the user's experience.

As I said in the review, the --print-all option should just be an addition. I never envisioned that the original option would be removed.

As far as the example on why someone would use the --print-found option...well, you can see it here. If someone has embedded the command line tool in a higher level script, then they may very want to ensure that no one changes the default setting on them. So, they would explicitly list what they desire.

@sdushantha
Copy link
Member

As far as the example on why someone would use the --print-found option...well, you can see it here. If someone has embedded the command line tool in a higher level script, then they may very want to ensure that no one changes the default setting on them. So, they would explicitly list what they desire.

Okay that makes sense, thanks for clearing it up :)

@sdushantha sdushantha deleted the update_cmdline branch November 14, 2020 07:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants