docments

module fastcore.docments in fastcore

Classes

builtins.object
    inspect._empty

empty

empty = class _empty(builtins.object)

 |  Marker object for Signature.empty and Parameter.empty.
 |  
 |  Data descriptors defined here:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)

Functions

`docments`

docments(elt, full=False, *, returns=True, eval_str=False)

    Generates a `docment`

`docstring`

docstring(sym)

    Get docstring for `sym` for functions ad classes

`get_dataclass_source`

get_dataclass_source(s)

    Get source code for dataclass `s`

`get_name`

get_name(obj)

    Get the name of `obj`

`get_source`

get_source(s)

    Get source code for string, function object or dataclass `s`

`isdataclass`

isdataclass(s)

    Check if `s` is a dataclass but not a dataclass' instance

`parse_docstring`

parse_docstring(sym)

    Parse a numpy-style docstring in `sym`

`qual_name`

qual_name(obj)

    Get the qualified name of `obj`