Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

Commit

Permalink
Other Sphinx documentation fixes
Browse files Browse the repository at this point in the history
- Treat ``post-save`` as code
- Fix indenting on ``InstanceEvent.__init__``
  • Loading branch information
jwhitlock committed Feb 9, 2018
1 parent ef30a12 commit 9c981f9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions tidings/events.py
Expand Up @@ -112,7 +112,7 @@ def fire(self, exclude=None, delay=True):
"""Notify everyone watching the event.
We are explicit about sending notifications; we don't just key off
creation signals, because the receiver of a post_save signal has no
creation signals, because the receiver of a ``post_save`` signal has no
idea what just changed, so it doesn't know which notifications to send.
Also, we could easily send mail accidentally: for instance, during
tests. If we want implicit event firing, we can always register a
Expand Down Expand Up @@ -569,11 +569,12 @@ class InstanceEvent(Event):
Subclasses must specify an ``event_type`` and should specify a
``content_type``.
"""
def __init__(self, instance, *args, **kwargs):
""":arg instance: the instance someone would have to be watching in
order to be notified when this event is fired
"""Initialize an InstanceEvent
:arg instance: the instance someone would have to be watching in
order to be notified when this event is fired.
"""
super(InstanceEvent, self).__init__(*args, **kwargs)
self.instance = instance
Expand Down

0 comments on commit 9c981f9

Please sign in to comment.