summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAgam Rafaeli <agam.rafaeli@gmail.com>2018-12-17 12:58:19 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2018-12-17 16:24:00 -0500
commite9d209c1d7dbda8b91e01d7ea4dfbd19af4207c5 (patch)
treeeaed750b852653b306de0645a203a105a9e0ece0
parenteb73b1a1cdb72e76bda65df2dd024e3efa7a254b (diff)
downloadsqlalchemy-e9d209c1d7dbda8b91e01d7ea4dfbd19af4207c5.tar.gz
Add missing parameter to docstring
Closes: #4410 Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/4410 Pull-request-sha: 070a0f44f3a6ce651e6b8e9dcc84d2d507d00845 Change-Id: I7a026bf6a2041e7686d90d5f155b88d8001f2ba8 (cherry picked from commit b1e4b597811768378d964e16bd142e8ee8c448d8)
-rw-r--r--lib/sqlalchemy/util/deprecations.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/sqlalchemy/util/deprecations.py b/lib/sqlalchemy/util/deprecations.py
index e3eebfc0c..9000cc795 100644
--- a/lib/sqlalchemy/util/deprecations.py
+++ b/lib/sqlalchemy/util/deprecations.py
@@ -25,6 +25,9 @@ def warn_pending_deprecation(msg, stacklevel=3):
def deprecated(version, message=None, add_deprecation_to_docstring=True):
"""Decorates a function and issues a deprecation warning on use.
+ :param version:
+ Issue version in the warning.
+
:param message:
If provided, issue message in the warning. A sensible default
is used if not provided.