Skip to content

Commit 61f208c

Browse files
committed
[ci skip] Documents update: class inheritance and __init__
1 parent 5627cba commit 61f208c

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

doc/source/advanced_property.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ API: AdvancedProperty
77
.. py:currentmodule:: advanced_descriptors
88
99
10-
.. py:class:: AdvancedProperty(fget=None, fset=None, fdel=None, fcget=None, )
10+
.. py:class:: AdvancedProperty(object)
1111
1212
Advanced property main entry point.
1313

14-
:param fget: normal getter.
15-
:type fget: ``typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]``
16-
:param fset: normal setter.
17-
:type fset: ``typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]``
18-
:param fdel: normal deleter.
19-
:type fdel: ``typing.Optional[typing.Callable[[typing.Any, ], None]]``
20-
:param fcget: class getter. Used as normal, if normal is None.
21-
:type fcget: ``typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]``
14+
.. py:method:: __init__(fget=None, fset=None, fdel=None, fcget=None, )
15+
16+
:param fget: normal getter.
17+
:type fget: ``typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]``
18+
:param fset: normal setter.
19+
:type fset: ``typing.Optional[typing.Callable[[typing.Any, typing.Any], None]]``
20+
:param fdel: normal deleter.
21+
:type fdel: ``typing.Optional[typing.Callable[[typing.Any, ], None]]``
22+
:param fcget: class getter. Used as normal, if normal is None.
23+
:type fcget: ``typing.Optional[typing.Callable[[typing.Any, ], typing.Any]]``
2224

2325
.. note:: doc argument is not supported due to class wide getter usage.
2426

doc/source/separate_classmethod.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,16 @@ API: SeparateClassMethod
77
.. py:currentmodule:: advanced_descriptors
88
99
10-
.. py:class:: SeparateClassMethod(imeth=None, cmeth=None, )
10+
.. py:class:: SeparateClassMethod(object)
1111
1212
Separate class method and instance methods.
1313

14-
:param imeth: Instance method
15-
:type imeth: ``typing.Optional[typing.Callable[..., typing.Any]]``
16-
:param cmeth: Class method
17-
:type cmeth: ``typing.Optional[typing.Callable[..., typing.Any]]``
14+
.. py:method:: __init__(imeth=None, cmeth=None, )
15+
16+
:param imeth: Instance method
17+
:type imeth: ``typing.Optional[typing.Callable[..., typing.Any]]``
18+
:param cmeth: Class method
19+
:type cmeth: ``typing.Optional[typing.Callable[..., typing.Any]]``
1820

1921
.. py:method:: instance_method(imeth)
2022

0 commit comments

Comments
 (0)