Showing input documentation with nbdev
show_doc(elt, doc_string:bool=True, name:str=None, title_level:int=None, disp:bool=True, default_cls_level:int=2)
Show documentation for element elt with potential verbose inputs. Supported types: class, function, and enum.
| Parameters: |
Type |
Default |
Details |
elt |
None Specified |
No Default |
Some function or class to pull up the documentation for |
doc_string |
<class 'bool'> |
True |
Whether to display the doc string |
name |
<class 'str'> |
None |
An optional name to use instead |
title_level |
<class 'int'> |
None |
The heading level |
disp |
<class 'bool'> |
True |
Whether to display the Markdown |
default_cls_level |
<class 'int'> |
2 |
If elt is a class, a heading level to use for it |
| Return Type |
Details |
<class 'str'> |
The documentation as a string |
doc(elt)
Show show_doc info in preview window when used in a notebook
| Parameters: |
Type |
Default |
Details |
elt |
None Specified |
No Default |
Some function or class to pull up the documentation for |