Currently param updates class docstrings to help with tab completion. I think this behavior is useful (and can be disabled by setting the docstring_signature variable to False but it might be worth considering two tweaks to this behavior:
- Only doing this for
ParameterizedFunction (might be tricky, currently the logic is on ParameterizedMetaclass)
- Only doing this when in an ipython context. This may also be hacky as it might mean trying to detect
get_ipython in the namespace (or similar).
I just want to consider these options as I would prefer to mutate docstrings only when tab-completion is actually relevant.
Currently param updates class docstrings to help with tab completion. I think this behavior is useful (and can be disabled by setting the
docstring_signaturevariable toFalsebut it might be worth considering two tweaks to this behavior:ParameterizedFunction(might be tricky, currently the logic is onParameterizedMetaclass)get_ipythonin the namespace (or similar).I just want to consider these options as I would prefer to mutate docstrings only when tab-completion is actually relevant.