AFQ.utils.docstring_parser#
Module Contents#
Functions#
|
Parse a NumPy-style docstring into parameter information. |
- AFQ.utils.docstring_parser.parse_numpy_docstring(docstring)[source]#
Parse a NumPy-style docstring into parameter information.
- Returns:
- dict: {
“description”: str (first section of docstring), “arguments”: {
- param_name: {
“help”: str (description), “metavar”: str (type), “default”: any (default value)
}
}
}