Skip to content

README.rst: Add detail to example #6

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.

Sign up for GitHub

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

Open
msabramo wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.rst: Add detail to example #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,21 @@ Example
-------

To obtain a signature object, pass the target function to the
``funcsigs.signature`` function. ::
``funcsigs.signature`` function.

.. code-block:: python

>>> from funcsigs import signature
>>> def foo(a, b=None, *args, **kwargs):
... pass

...
>>> sig = signature(foo)
>>> sig
<funcsigs.Signature object at 0x1005edd50>
>>> sig.parameters
OrderedDict([('a', <Parameter at 0x100768310 'a'>), ('b', <Parameter at 0x1007683c0 'b'>), ('args', <Parameter at 0x100768418 'args'>), ('kwargs', <Parameter at 0x100768470 'kwargs'>)])
>>> sig.return_annotation
<class 'funcsigs._empty'>

For the details of the signature object, refer to the either the package of
standard library documentation.
Expand Down