Document `UsageError`

[allanlewis]

The exception pytest.UsageError is useful for validating that required options (specified in pytest_addoption) are set, or that other environmental factors are sane. However, it's currently undocumented: perhaps it should be added to the public API and therefore the published documentation?

[nicoddemus]

Indeed, thanks for the report @allanlewis.

[goodship1]

I will give it a ago

[IronPenguin4179]

@goodship1 Any progress on this one, or can I pick it up?

[goodship1]

@justinwalker4179 sorry totally forgot about this. Yeh man pick it up

[Pulkit07]

Hi, is there any example of similar errors which are part of public API? I am trying to understand how the public API is denoted in the code.

[nicoddemus]

Hi @Pulkit07, thanks for the interest.

Sadly we don't have any exceptions documented in the docs. I believe a good place to put them is in https://docs.pytest.org/en/latest/reference.html, under a new "Exceptions" section.