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

Documentation refers to options that do not exist in the latest released version #167

Closed
tonnydourado opened this issue Mar 3, 2023 · 1 comment · Fixed by #168
Closed
Labels
chore Boring, but important, stuff
Milestone

Comments

@tonnydourado
Copy link

In the read-the-docs documentation there's reference to a --syntax parameter, but passing this in the command line gives an error:

(venv) ~$ docformatter --syntax sphinx bla.py
usage: docformatter [-h] [-i | -c] [-d] [-r] [-e [EXCLUDE [EXCLUDE ...]]] [--wrap-summaries length]
                    [--wrap-descriptions length] [--force-wrap] [--tab-width width] [--blank] [--pre-summary-newline]
                    [--pre-summary-space] [--make-summary-multi-line] [--close-quotes-on-newline] [--range line line]
                    [--docstring-length length length] [--non-strict] [--config CONFIG] [--version]
                    files [files ...]
docformatter: error: unrecognized arguments: --syntax

Am I missing something about how to use this parameter?

Python: tested on versions 3.8 (Ubuntu on WSL) and 3.9 (Windows)
docformatter: both pip and pipx report 1.5.1, but weirdly, docformatter --version reports 1.5.0 ?

@github-actions github-actions bot added the fresh This is a new issue label Mar 3, 2023
@weibullguy weibullguy added chore Boring, but important, stuff and removed fresh This is a new issue labels Mar 3, 2023
@weibullguy weibullguy added this to the v1.6.0 milestone Mar 3, 2023
@weibullguy
Copy link
Member

Sorry, that section with the --syntax and --black shouldn't be in the latest docs. Looks like I accidentally copied it over from my notes. Both of those options are future (the --black option is being worked in #166). The version info come from two different places for pip and docformatter --version. The second didn't get updated, but that'll be fixed moving forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Boring, but important, stuff
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants