Skip to content

Commit

Permalink
Make sure dunderscore docstrings are included
Browse files Browse the repository at this point in the history
  • Loading branch information
erikkemperman committed Jun 4, 2019
1 parent 723b625 commit db8b849
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@
'sphinxcontrib_dooble',
]

# Include a separate entry for special methods, like __init__, where provided.
autodoc_default_options = {
'member-order': 'bysource',
'special-members': True,
'exclude-members': '__dict__,__weakref__'
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
12 changes: 6 additions & 6 deletions rx/subjects/behaviorsubject.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ def __init__(self, value):
creates a subject that caches its last value and starts with the
specified value.
Keyword parameters:
:param T value: Initial value sent to observers when no other
value has been received by the subject yet.
Args:
value: Initial value sent to observers when no other value has been
received by the subject yet.
"""

super(BehaviorSubject, self).__init__()
Expand Down Expand Up @@ -73,7 +73,7 @@ def on_completed(self) -> None:
o.on_completed()

def on_error(self, error: Exception) -> None:
"""Notifie all subscribed observers with the exception."""
"""Notifies all subscribed observers with the exception."""
os = None
with self.lock:
self.check_disposed()
Expand All @@ -88,7 +88,7 @@ def on_error(self, error: Exception) -> None:
o.on_error(error)

def on_next(self, value: Any) -> None:
"""Notifie all subscribed observers with the value."""
"""Notifies all subscribed observers with the value."""
os = None
with self.lock:
self.check_disposed()
Expand All @@ -103,7 +103,7 @@ def dispose(self) -> None:
"""Release all resources.
Releases all resources used by the current instance of the
ReplaySubject class and unsubscribe all observers.
BehaviorSubject class and unsubscribe all observers.
"""
with self.lock:
self.is_disposed = True
Expand Down

0 comments on commit db8b849

Please sign in to comment.