Skip to content

Commit 1e8c170

Browse files
Make sure dunderscore docstrings are included (#418)
1 parent 7edf352 commit 1e8c170

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

docs/conf.py

+7
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@
6060
'sphinxcontrib_dooble',
6161
]
6262

63+
# Include a separate entry for special methods, like __init__, where provided.
64+
autodoc_default_options = {
65+
'member-order': 'bysource',
66+
'special-members': True,
67+
'exclude-members': '__dict__,__weakref__'
68+
}
69+
6370
# Add any paths that contain templates here, relative to this directory.
6471
templates_path = ['_templates']
6572

rx/subject/behaviorsubject.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ def __init__(self, value) -> None:
1717
creates a subject that caches its last value and starts with the
1818
specified value.
1919
20-
Keyword parameters:
21-
:param T value: Initial value sent to observers when no other
22-
value has been received by the subject yet.
20+
Args:
21+
value: Initial value sent to observers when no other value has been
22+
received by the subject yet.
2323
"""
2424

2525
super().__init__()
@@ -55,7 +55,7 @@ def dispose(self) -> None:
5555
"""Release all resources.
5656
5757
Releases all resources used by the current instance of the
58-
ReplaySubject class and unsubscribe all observers.
58+
BehaviorSubject class and unsubscribe all observers.
5959
"""
6060

6161
with self.lock:

0 commit comments

Comments
 (0)