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

Add description of the options for pytest in the docs #317

Open
jwreep opened this issue Sep 26, 2024 · 1 comment
Open

Add description of the options for pytest in the docs #317

jwreep opened this issue Sep 26, 2024 · 1 comment

Comments

@jwreep
Copy link
Collaborator

jwreep commented Sep 26, 2024

I'd like to suggest a small improvement to the docs. The description of how to use the pytests is currently a bit limited. It would be helpful to have a page or short list explaining each option for pytest that can be used with fiasco. I was having a bit of trouble understanding some options for running the pytests.

For example,

pytest --ascii-dbase-url http://download.chiantidatabase.org/CHIANTI_v9.0.1_database.tar.gz --skip-version-check --disable-file-hash has three separate switches, but they're not explained in the docs. The first is self-explanatory, but it's not clear what the latter two do without digging into the code.

@wtbarnes
Copy link
Owner

I completely agree. This needs to be documented much better. I suspect you're the first person besides me to use any of these!

We should do two things:

  1. Add some narrative docs to this section of the how-to guides: https://fiasco.readthedocs.io/en/stable/how_to_guides.html#run-the-test-suite
  2. Document each custom argument in the conftest.py: https://github.com/wtbarnes/fiasco/blob/6642b07c4d56f8327ea30e4aaf20da96a4258498/conftest.py. I did it for the last argument (using the help=... kwarg). If we do this, these explanations show up in the "Custom options" section when you run pytest -h.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants