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 full-length versions of CLI flags #11776
Conversation
doc/man/sphinx-build.rst
Outdated
.. versionchanged:: 7.3 | ||
Add ``--write`` long option. | ||
|
||
.. option:: -W, --errors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would --fail-fast
be a better name than --errors
?
I don't find --errors
particularly descriptive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, this option is often used in combination with:
--keep-going with -W, keep going when getting warnings
My thinking was these might go together:
--errors --keep-going
And --fail-fast
would seem to contradict it:
--fail-fast --keep-going
Open to other suggestions!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If possible, I would have suggested --fatal-warnings
because it's exactly what it does for gcc
. Or we can go for --warning-is-error
or --warn-as-error
(but I would prefer the former).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer --fail-on-warning
here, it's more descriptive, if a little wordier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I usually try to come with flags that are used by other well-known tools because it makes less options to remember overall, but I think yours is a bit betetr when used with --keep-going
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
doc/man/sphinx-build.rst
Outdated
.. versionchanged:: 7.3 | ||
Add ``--all`` long option. | ||
|
||
.. option:: -E, --no-env |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe --isolate
or --no-incremental
to mimick Python/mypy options (I think --no-incremental
is more correct since --isolate
may assume not looking for the configuration file).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ruff has --isolated
to ignore config:
--isolated
Ignore all configuration files
Mypy has --no-incremental
to disable the cacge:
Incremental mode:
Adjust how mypy incrementally type checks and caches modules. Mypy caches type information about modules into a cache to let you speed up future
invocations of mypy. Also see mypy's daemon mode: mypy.readthedocs.io/en/stable/mypy_daemon.html#mypy-daemon
--no-incremental Disable module cache (inverse: --incremental)
I couldn't find similar Python options.
Mypy's --no-incremental
seems closer, will update to use that 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fot Python it's -I
for "isolated".
doc/man/sphinx-build.rst
Outdated
.. versionchanged:: 7.3 | ||
Add ``--write`` long option. | ||
|
||
.. option:: -W, --errors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If possible, I would have suggested --fatal-warnings
because it's exactly what it does for gcc
. Or we can go for --warning-is-error
or --warn-as-error
(but I would prefer the former).
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Btw for the |
An alternate suggestion for A |
Feature or Bugfix
Purpose
sphinx-build
Detail
sphinx-build
and often have to re-look them up via--help
sphinx-build
via aMakfile
, and long options are just fine there, and better at self-documentingI didn't add any for these two because I wasn't sure what their long versions could be:
Relates
--jobs
a synonym for-j
#11210 added--jobs