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

Poor advice on placing section in setup.cfg. #26

Open
tmarktaylor opened this issue Mar 30, 2022 · 0 comments
Open

Poor advice on placing section in setup.cfg. #26

tmarktaylor opened this issue Mar 30, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tmarktaylor
Copy link
Owner

tmarktaylor commented Mar 30, 2022

In the documentation chapter "Using a configuration file" please disregard the example placing a [tool.phmdoctest] section in setup.cfg. Pytest 7 advises a [tool:*] (colon) and discourages use in setup.cfg. I suspect some other tools may use the colon to discover tool configuration sections in setup.cfg.

For the next version of phmdoctest >1.4.0:

  • Add advice to prefer the .toml format followed
    by .ini. and finally .cfg.
  • Allow[tool:phmdoctest] in *.cfg.
  • Allow [tool.phmdoctest] in *.cfg to remain back
    compatible with phmdoctest 1.4.0.

Note that the name of the configuration file is explictly passed to phmdoctest in place of the Markdown file. There is no requirement to place the configuration section in an existing configuration file. It can be placed in a new file.

@tmarktaylor tmarktaylor added the documentation Improvements or additions to documentation label Mar 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant