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

Configuration documentation doesn't say what file name you need #467

Closed
boxed opened this issue Apr 28, 2020 · 1 comment
Closed

Configuration documentation doesn't say what file name you need #467

boxed opened this issue Apr 28, 2020 · 1 comment
Assignees
Labels

Comments

@boxed
Copy link

boxed commented Apr 28, 2020

https://docs.nose2.io/en/latest/configuration.html#configuration-files is missing a bit of crucial information: what is the name of the .ini file? It looks like it can be both "unittest.cfg" or "nose2.cfg" if I read the code. Is this correct?

@sirosen sirosen self-assigned this May 7, 2020
@sirosen
Copy link
Collaborator

sirosen commented May 7, 2020

Yes, it's unittest.cfg or nose2.cfg by default. The docs say so, but only under the -c option, not where the use of ini config is first mentioned.

I think the doc could actually expand out into separate paragraphs to put this towards the top, something like

nose2 can be configured via standard, ini-style config files. The default files are unittest.cfg and nose2.cfg in the start directory.

[more doc in following paragraph]

I'll close this when I can make a tweak to the doc to make this more prominent.

@sirosen sirosen added the docs label May 7, 2020
@sirosen sirosen closed this as completed in a1f4757 Feb 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants