Skip to content

Commit

Permalink
document that we don't require napoleon_use_param = True anymore
Browse files Browse the repository at this point in the history
  • Loading branch information
keewis committed Aug 4, 2020
1 parent 2c75aaa commit c22866a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion sphinx/ext/napoleon/__init__.py
Expand Up @@ -239,7 +239,7 @@ def __unicode__(self):
napoleon_type_aliases : :obj:`dict` (Defaults to None)
Add a mapping of strings to string, translating types in numpy
style docstrings. Only works when ``napoleon_use_param = True``.
style docstrings.
napoleon_custom_sections : :obj:`list` (Defaults to None)
Add a list of custom sections to include, expanding the list of parsed sections.
Expand Down

0 comments on commit c22866a

Please sign in to comment.