Skip to content

Commit

Permalink
list features in docs index
Browse files Browse the repository at this point in the history
  • Loading branch information
epsy committed Jul 14, 2022
1 parent d9b2639 commit 05f8ec2
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/index.rst
Expand Up @@ -8,9 +8,12 @@ for determining function signatures. This is useful for libraries or tooling
that want to know how a function can be called: Documentation generators, IDEs,
and tools that adapt themselves to functions they are given.

``sigtools`` also provides a backport of Python 3's keyword-only parameters and
function annotations.
``sigtools`` provides:

- Utilities to boost introspection of callables' signature
- Backports of Python 3's keyword-only parameters for code that used to maintain both Python 2 and 3 compatibility.
- Utilities for combining functions, for instance for creating decorators
- A :doc:`Sphinx <sphinx:usage/index>` extension to make use of improved signature introspection in `sphinx.ext.autodoc`

.. toctree::
:caption: Guide
Expand Down

0 comments on commit 05f8ec2

Please sign in to comment.