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.

Sign up for GitHub

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

Jump to bottom

--help output in README.rst may go out of sync #364

Closed
akaihola opened this issue Apr 27, 2022 · 0 comments · Fixed by #365
Closed

--help output in README.rst may go out of sync #364

akaihola opened this issue Apr 27, 2022 · 0 comments · Fixed by #365
Assignees
@akaihola
Labels
CI
Milestone
Darker 1.5.1

Comments

@akaihola
Copy link
Owner

After modifying the command line interface or its help texts, README.rst needs to be updated manually to match the output of darker --help.

While there is tooling to help do this (darker --options-for-readme), this task is easily forgotten.

It would be useful if the test suite checked that darker --help and README.rst are in sync.
@akaihola akaihola added the CI label Apr 27, 2022
@akaihola akaihola added this to the 1.5.1 milestone Apr 27, 2022
@akaihola akaihola self-assigned this Apr 27, 2022
@akaihola akaihola changed the title --help output in README.rst may be out of sync --help output in README.rst may go out of sync Apr 27, 2022
@akaihola akaihola linked a pull request Apr 27, 2022 that will close this issue
Use CI to ensure README contains usage text #365
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@akaihola akaihola

Labels
CI
Projects
None yet
Milestone
Darker 1.5.1
Development

Successfully merging a pull request may close this issue.

Use CI to ensure README contains usage text akaihola/darker
1 participant
@akaihola