Skip to content

Commit

Permalink
docs: Add note about Black formatting for signatures
Browse files Browse the repository at this point in the history
  • Loading branch information
pawamoy committed Aug 17, 2022
1 parent e2719e6 commit 639d11e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/mkdocstrings_handlers/python/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ class PythonHandler(BaseHandler):
annotations_path (str): The verbosity for annotations path: `brief` (recommended), or `source` (as written in the source). Default: `"brief"`.
show_signature (bool): Show methods and functions signatures. Default: `True`.
show_signature_annotations (bool): Show the type annotations in methods and functions signatures. Default: `False`.
separate_signature (bool): Whether to put the whole signature in a code block below the heading. Default: `False`.
separate_signature (bool): Whether to put the whole signature in a code block below the heading.
If Black is installed, the signature is also formatted using it. Default: `False`.
Attributes: Additional options:
show_bases (bool): Show the base classes of a class. Default: `True`.
Expand Down

0 comments on commit 639d11e

Please sign in to comment.