summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/util
diff options
context:
space:
mode:
authormike bayer <mike_mp@zzzcomputing.com>2018-12-17 21:22:58 +0000
committerGerrit Code Review <gerrit@bbpush.zzzcomputing.com>2018-12-17 21:22:58 +0000
commit3b6ff1b9f9d740f9a5b11b1774ee77c563926f84 (patch)
tree9e56ce50c632c6aa7410b8f6074dca42782ae4ad /lib/sqlalchemy/util
parent99fc012d727da637f05e9b6aa5e7a1b80ef401ff (diff)
parentb1e4b597811768378d964e16bd142e8ee8c448d8 (diff)
downloadsqlalchemy-3b6ff1b9f9d740f9a5b11b1774ee77c563926f84.tar.gz
Merge "Add missing parameter to docstring"
Diffstat (limited to 'lib/sqlalchemy/util')
-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.