github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

@documented decorator plus unit test plus sphinx.ext.autodoc

Browse source 
New mechanism for marking datasette.utils functions that should be covered by the
documentation, then testing that they have indeed been documented.

Also enabled sphinx.ext.autodoc which can now be used to embed the documented
versions of those functions.

Refs #1176
This commit is contained in:
Simon Willison 2022-02-06 22:30:00 -08:00
commit d9b508ffaa
4 changed files with 43 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/internals.rst
View file

@ -865,6 +865,17 @@ This function accepts a string containing either JSON or YAML, expected to be of
If the metadata cannot be parsed as either JSON or YAML the function will raise a ``utils.BadMetadataError`` exception.
.. autofunction:: datasette.utils.parse_metadata
.. _internals_utils_await_me_maybe:
await_me_maybe(value)
---------------------
Utility function for calling ``await`` on a return value if it is awaitable, otherwise returning the value. This is used by Datasette to support plugin hooks that can optionally return awaitable functions. Read more about this function in `The “await me maybe” pattern for Python asyncio <https://simonwillison.net/2020/Sep/2/await-me-maybe/>`__.
.. autofunction:: datasette.utils.await_me_maybe
.. _internals_tracer:
datasette.tracer