I'm working in a jupyter notebook using python and trying to use the auto-documentation function to generate docstrings like below. When working in an IDE like pycharm a triple quotation + Enter underneath the function generates docstrings like shown below.
def test_function(df: pd.DataFrame, probs: dict) -> int:
"""
:param df:
:param probs:
:return:
"""
Currently my output from the notebook gives the output below and does not parse any arguments inside the function.
def test_function(df: pd.DataFrame, probs: dict) -> int:
"""
"""
You can have that functionality in VScode, sublime, pytorch and other IDEs but not in jupyter the closest solution I found was to install nbextensions and use snippets to add a docstring template. it decreases typing by 50% but still not auto generating.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With