diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-12-18 15:01:49 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-12-18 15:26:42 +0900 |
| commit | 733ac6ed5fa75136b127766a7b08b1dbe67c9cb6 (patch) | |
| tree | b1163b112061aaa871d7c38cae33d2d116dc3884 | |
| parent | 8d0fd9e74a6d44ca1a518225d9be030d91917c9b (diff) | |
| download | sphinx-git-733ac6ed5fa75136b127766a7b08b1dbe67c9cb6.tar.gz | |
doc: Update explanation of autodoc_unqualified_typehints (ref: #9931)
| -rw-r--r-- | doc/usage/extensions/autodoc.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/usage/extensions/autodoc.rst b/doc/usage/extensions/autodoc.rst index dab09c92c..d775ddee8 100644 --- a/doc/usage/extensions/autodoc.rst +++ b/doc/usage/extensions/autodoc.rst @@ -664,8 +664,8 @@ There are also config values that you can set: .. confval:: autodoc_unqualified_typehints - If True, the leading module names of typehints of function signatures (ex. - ``io.StringIO`` -> ``StringIO``). Defaults to False. + If True, the leading module names of typehints of function signatures are + removed (ex. ``io.StringIO`` -> ``StringIO``). Defaults to False. .. versionadded:: 4.4 |