Skip to content

Commit

Permalink
Fix outdated documenation segments
Browse files Browse the repository at this point in the history
  • Loading branch information
codingjoe committed Oct 5, 2020
1 parent 925a283 commit 586199d
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ like:
ship = tasks.UpdateView(fields=["tracking_code"])
def has_email(self, task):
def has_email(self):
if self.email:
return [self.send_tracking_code]
def send_tracking_code(self, task):
def send_tracking_code(self):
send_mail(
subject="Your tracking code",
message=self.tracking_code,
Expand Down
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ def linkcode_resolve(domain, info):
"https://docs.djangoproject.com/en/stable/",
"https://docs.djangoproject.com/en/stable/_objects/",
),
"celery": ("https://celery.readthedocs.io/en/stable/", None),
"dramatiq": ("https://dramatiq.io/", None),
"celery": ("https://docs.celeryproject.org/en/stable/", None),
"graphviz": ("https://graphviz.readthedocs.io/en/stable/", None),
}

Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ may look like:
checkout [color=black fontcolor=black style="filled, rounded"]
"has email" [color=black fontcolor=black style=filled]
ship [color=black fontcolor=black style="filled, rounded"]
end [color=black fontcolor=black style=filled]
end [color=black fontcolor=black style=filled peripheries=2]
"send tracking code" [color=black fontcolor=black style=filled]
checkout -> ship
ship -> "has email"
"has email" -> "send tracking code"
"has email" -> end
"has email" -> end [color="#888888"]
"send tracking code" -> end
}

Expand All @@ -55,15 +55,15 @@ may look like:
if self.email:
return [self.send_tracking_code]
def send_tracking_code(self, task):
def send_tracking_code(self):
send_mail(
subject="Your tracking code",
message=self.tracking_code,
from_email=None,
recipient_list=[self.email],
)
def end(self, task):
def end(self):
pass
edges = [
Expand Down

0 comments on commit 586199d

Please sign in to comment.