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

No reference documentation? #1713

Closed
darkfeline opened this Issue Jul 11, 2016 · 1 comment

Comments

Projects
None yet
3 participants
@darkfeline

darkfeline commented Jul 11, 2016

pytest has no reference documentation (as far as I can tell). This is problematic, because while the documentation tells me pytest's basic usage, I have no idea what anything actually does.

Even something as simple as pytest.fixture is undocumented. What does it do? What arguments does it take? What, specifically, do scope='function', scope='class', and scope='session' do?

It's quite possible however that I simply haven't found the documentation, as silly as that sounds. Consider for example this page, which doesn't seem to be linked from anywhere and hence isn't included in the PDF documentation either. Perhaps there's some reference documentation hidden in the pytest Deep web that I'm missing?

@The-Compiler

This comment has been minimized.

Member

The-Compiler commented Jul 11, 2016

We're aware the current documentation structure is suboptimal, and we're trying to come up with something better soon for pytest 3.0.

FWIW, you can find the documentation for pytest.fixture here:
http://pytest.org/latest/builtin.html#_pytest.python.fixture
http://pytest.org/latest/fixture.html

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