speechbrain.utils.check_docstrings module
This library contains functions that checks the dosctrings
- Authors
Mirco Ravanelli 2022
Summary
Functions:
Checks if all the functions or classes have a docstring. |
|
Extracts the names of the function or classes in the input string. |
Reference
- speechbrain.utils.check_docstrings.extractName(s, search_class=False)[source]
Extracts the names of the function or classes in the input string.
- Parameters
s (string) – Input string where to search for function or class names.
search_clas (bool) – If True, searches for class names.
- Returns
string – Name of the function or class detected.
- Return type
string