Skip to content

Commit

Permalink
Better docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Nov 19, 2018
1 parent 6c31bb1 commit a4e7ef3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions readthedocs/notifications/decorators.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
def notify_deprecated_endpoint(function):
"""
Decorator to notify owners that the endpoint is DEPRECATED.
.. note::
See the class ``DeprecatedWebhookEndpointNotification`` which contains
all the logic to send notification for this messages properly without
spamming.
"""
def wrap(*args, **kwargs):
# Called from ``generic_build``
Expand Down

0 comments on commit a4e7ef3

Please sign in to comment.