diff options
author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-12-22 00:53:27 +0900 |
---|---|---|
committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-12-22 00:53:27 +0900 |
commit | 22080940e252fe47cb1dccf3fd9029b7c9d21de5 (patch) | |
tree | 1c61a414f169c532b55592fffd31fa9fec36c2ac | |
parent | 4431f11876e05ff2e8f85c087b3df749d3b28a6f (diff) | |
download | sphinx-git-22080940e252fe47cb1dccf3fd9029b7c9d21de5.tar.gz |
doc: Update docstring of getslots()
-rw-r--r-- | sphinx/util/inspect.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py index a26c818c0..767ef319c 100644 --- a/sphinx/util/inspect.py +++ b/sphinx/util/inspect.py @@ -187,6 +187,7 @@ def getslots(obj: Any) -> Optional[Dict]: Return None if gienv *obj* does not have __slots__. Raises AttributeError if given *obj* raises an error on accessing __slots__. + Raises TypeError if given *obj* is not a class. Raises ValueError if given *obj* have invalid __slots__. """ if not inspect.isclass(obj): |