Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add more documentation for how --save can be used with examples #516

Closed
canyon289 opened this issue Jan 9, 2019 · 5 comments
Closed

Add more documentation for how --save can be used with examples #516

canyon289 opened this issue Jan 9, 2019 · 5 comments
Labels
User Documentation Documentation outside of the codebase

Comments

@canyon289
Copy link
Member

Tell us about it

The functionality to save plots during tests exists. The documentation to make it clear doesn't

Thoughts on implementation

Copying and pasting prior discussion here

pytest arviz/tests --save -k plot_forest
the -k keyword will string match test function, class, and i think module names to just test those

https://docs.pytest.org/en/latest/example/markers.html#using-k-expr-to-select-tests-based-on-
their-name

@canyon289 canyon289 added the User Documentation Documentation outside of the codebase label Jan 24, 2019
@OriolAbril
Copy link
Member

with #1331 maybe this could be added to the testing arviz code of the restructured docs?

@michaelraczycki
Copy link
Contributor

@OriolAbril since #1331 is closed, should it also be closed or it's still open? If it's open I can do it

@OriolAbril
Copy link
Member

it is still open, we did restructure the docs, but there are still many pages that were listed as potential additions that are missing. Here I would create a how-to page similar to https://python.arviz.org/en/latest/contributing/sphinx_doc_build.html but for tests and explain the use of --save there

@OriolAbril
Copy link
Member

Also just realized this comment (and whole discussion in general) are related to this, and will be helpful for the "how to run the test suite" page: #2110 (comment)

@OriolAbril
Copy link
Member

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
User Documentation Documentation outside of the codebase
Projects
None yet
Development

No branches or pull requests

3 participants