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

--no-text didn't list as a single option in help #1091

Closed
networm opened this issue Oct 25, 2018 · 5 comments
Closed

--no-text didn't list as a single option in help #1091

networm opened this issue Oct 25, 2018 · 5 comments
Labels
doc An issue with or an improvement to documentation.

Comments

@networm
Copy link

networm commented Oct 25, 2018

What version of ripgrep are you using?

ripgrep 0.10.0
-SIMD -AVX (compiled)
+SIMD +AVX (runtime)

How did you install ripgrep?

brew install ripgrep

What operating system are you using ripgrep on?

macOS Mojave 10.14

Describe your question, feature request, or bug.

--no-text didn't list as a single option in help

--no-text only appeared once in -a, --text description, I think it should be listed as well as others.

If this is a bug, what are the steps to reproduce the behavior?

rg --help

If possible, please include both your search patterns and the corpus on which
you are searching. Unless the bug is very obvious, then it is unlikely that it
will be fixed if the ripgrep maintainers cannot reproduce it.

If the corpus is too big and you cannot decrease its size, file the bug anyway
and the ripgrep maintainers will help figure out next steps.

If this is a bug, what is the actual behavior?

There is no --no-text option in help.

If this is a bug, what is the expected behavior?

List --no-text as well as other options.

@BurntSushi
Copy link
Owner

I sympathize, but almost every binary flag has a --no- variant. I don't want to flood the man page or the help output with all of them. The compromise we've made is to put them in the relevant flag's long form description.

Perhaps a better compromise would be to include a note about the existence of --no flags in the top-level docs, before the listing of flags?

@networm
Copy link
Author

networm commented Oct 25, 2018

I think it should be ok if there is --no flags in top level docs.
But there is so many --no-* options in man page by alphabetical order, they should be consistent. Or there will be someone like me who is confused.

@BurntSushi
Copy link
Owner

It's consistent, but perhaps not in the way you expect. Flags listed in the man page are really about changing the default behavior. Sometimes it makes sense to phrase those flags negatively. For example, ripgrep's default behavior is to respect ignore files, but that can be turned off via --no-ignore, and even turned back on again with --ignore. But --ignore is much less useful than --no-ignore since it's already enabled by default, so --no-ignore is the one that gets the spotlight.

But yeah, we can add a note about this in the overview. I think at this point I'd be strongly opposed to adding all of the --no flags to the docs.

@BurntSushi BurntSushi added the doc An issue with or an improvement to documentation. label Oct 25, 2018
@networm
Copy link
Author

networm commented Oct 25, 2018

Thank you for your explanation. I have learned about it.
I think add a note in the overview is very good. So should I close issue now or wait for the added note?

@BurntSushi
Copy link
Owner

BurntSushi commented Oct 25, 2018 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc An issue with or an improvement to documentation.
Projects
None yet
Development

No branches or pull requests

2 participants