finesse.script.adapter.BaseAdapter.doc_signature¶
- BaseAdapter.doc_signature(exclude_name=False)[source]¶
The signature of the documentation object.
This is an ordered mapping of the Python object’s supported parameters to
inspect.Parameter
objects.- Parameters
exclude_name : bool, optional
Exclude the name parameter. This is useful for code that already handles the name separately. Defaults to False.
- Returns
-
The documentation object’s pseudo-signature.