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

Message printed with --help change defaults on config detection #113

Closed
fmigneault opened this issue Aug 20, 2022 · 1 comment · Fixed by #111
Closed

Message printed with --help change defaults on config detection #113

fmigneault opened this issue Aug 20, 2022 · 1 comment · Fixed by #111
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: bug PEP 257 violation or existing functionality that doesn't work as documented

Comments

@fmigneault
Copy link

fmigneault commented Aug 20, 2022

I'm not sure if this is intentional or not, but I noticed this and wanted to make sure to report the potential issue.

When a configuration file (setup.cfg, tox.ini or pyproject.toml) is auto-detected in the local directory, values printed as defaults in --help change accordingly to parsed settings of this file.
If the user runs the command from anywhere else than the directory where the config is located, those defaults suddenly change back. They also revert to the "real defaults" if we call docformatter --help --config "".

This could make users confused about "defaults" since those are usually reported as "value used if nothing was specified", but in this case they change based on a specified value.

@github-actions github-actions bot added the fresh This is a new issue label Aug 20, 2022
@weibullguy weibullguy added P: bug PEP 257 violation or existing functionality that doesn't work as documented C: stakeholder Relates to docformatter stakeholder requested behavior and removed fresh This is a new issue labels Aug 20, 2022
@weibullguy
Copy link
Member

Interesting. But I know what's causing it and it's an easy fix. Until then, the defaults are found in the documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: bug PEP 257 violation or existing functionality that doesn't work as documented
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants