-
-
Notifications
You must be signed in to change notification settings - Fork 164
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
Unify cli validation interfaces #467
Comments
I'll tackle this one after #466 |
Is there a preference between these two options? $ numpydoc render # runs the current numpydoc CLI's render_object()
$ numpydoc validate # runs the current --validate
$ numpydoc validate --ast # runs the current numpydoc.hooks.validate_docstrings OR to not affect current users: $ numpydoc # runs the current numpydoc CLI's render_object()
$ numpydoc --validate # runs the current --validate
$ numpydoc --ast-validation # runs the current numpydoc.hooks.validate_docstrings I'm calling the hook method "ast" because it uses the abstract syntax tree unlike the original validation, but let me know if we should use something else. |
How about:
|
And |
Or just drop the alias; it's not like this is done so often by hand. |
Looking at this more, I actually don't think the How about having separate subcommands for each? $ numpydoc render
$ numpydoc validate
$ numpydoc hook |
Nice and clean; I prefer that too. |
|
See #454
python -m numpydoc
python -m numpydoc.hooks.validate_docstrings
These CLI interfaces do slightly different things, but one could imagine a command word interface a-la git.
Also, it would be good to expose this as an executable user-script
numpydoc
./cc @stefmolin
The text was updated successfully, but these errors were encountered: