Improve @example docs
#4418
Improve @example docs
#4418
Conversation
|
|
||
| Methods | ||
| ------- | ||
| Database methods | ||
| ---------------- | ||
|
|
There was a problem hiding this comment.
Methods is a keyword in numpy-style docstrings, so this fixes some rendering issues after adding the napoleon extension.
There was a problem hiding this comment.
We should consider using the new py:deco role for all our decorators: sphinx-doc/sphinx#13292 ... once we update Sphinx to 8.2, which I presume is blocked on a plugin or something. Hmm.
There was a problem hiding this comment.
I like the updated @given() docs!
They also convince me that the whole "inferred arguments" section should be divided up among the docstrings for given, st.builds, and st.from_type. Currently it's a bit fuzzy, and I think this (with xrefs of course) would actually make it easier to understand what happens.
Yeah, agree we'll want something like this, likely alongside a "working with types" tutorial or how-to. |
(with a fair bit of content rewriting, not just moving the
@exampledocs from .rst to .py)