Skip to content

Commit 0281339

Browse files
committed
docs: update parameter count in examples
1 parent ef940c6 commit 0281339

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ Function(name='pow', parameters=2, description='Return x**y (x to the power of y
4848
'docstring': 'Return x**y (x to the power of y).'
4949
}
5050

51-
>>> inspect(inspect)
52-
Function(name='inspect', parameters=7, description='Inspects an object and returns a structured representation of its attributes and methods.')
53-
```
51+
>>> inspect(inspect)
52+
Function(name='inspect', parameters=8, description='Inspects an object and returns a structured representation of its attributes and methods.')
53+
```
5454

5555
### prettydir
5656

docs/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# objinspect
2-
2+
33
[![Tests](https://github.com/zigai/objinspect/actions/workflows/tests.yml/badge.svg)](https://github.com/zigai/objinspect/actions/workflows/tests.yml)
44
[![Documentation Status](https://readthedocs.org/projects/objinspect/badge/?version=latest)](https://objinspect.readthedocs.io/en/latest/?badge=latest)
55
[![PyPI version](https://badge.fury.io/py/objinspect.svg)](https://badge.fury.io/py/objinspect)
66
![Supported versions](https://img.shields.io/badge/python-3.10+-blue.svg)
77
[![Downloads](https://static.pepy.tech/badge/objinspect)](https://pepy.tech/project/objinspect)
88
[![license](https://img.shields.io/github/license/zigai/objinspect.svg)](https://github.com/zigai/objinspect/blob/main/LICENSE)
99

10-
`objinspect` is a high-level wrapper around Python's built-in `inspect` module.
10+
`objinspect` is a high-level wrapper around Python's built-in `inspect` module.
1111
It provides a simple interface for examining Python functions and classes.
1212

1313
## Features
@@ -35,15 +35,15 @@ Function(name='pow', parameters=2, description='Return x**y (x to the power of y
3535

3636
>>> inspect(math.pow).dict
3737
{
38-
'name': 'pow',
38+
'name': 'pow',
3939
'parameters': [
40-
{'name': 'x', 'kind': <_ParameterKind.POSITIONAL_ONLY: 0>, 'type': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>, 'description': None},
41-
{'name': 'y', 'kind': <_ParameterKind.POSITIONAL_ONLY: 0>, 'type': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>, 'description': None}],
40+
{'name': 'x', 'kind': <_ParameterKind.POSITIONAL_ONLY: 0>, 'type': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>, 'description': None},
41+
{'name': 'y', 'kind': <_ParameterKind.POSITIONAL_ONLY: 0>, 'type': <class 'inspect._empty'>, 'default': <class 'inspect._empty'>, 'description': None}],
4242
'docstring': 'Return x**y (x to the power of y).'
4343
}
44-
44+
4545
>>> inspect(inspect)
46-
Function(name='inspect', parameters=7, description='Inspects an object and returns a structured representation of its attributes and methods.')
46+
Function(name='inspect', parameters=8, description='Inspects an object and returns a structured representation of its attributes and methods.')
4747
```
4848
### prettydir
4949
![image](https://github.com/zigai/objinspect/assets/69588680/e1adcf90-0ef3-49e4-8804-a662f6388475)

0 commit comments

Comments
 (0)