Update docstring with original description of foreign variables

xarray-contrib / xarray-simlab

Xarray extension and framework for computer model simulations

http://xarray-simlab.readthedocs.io

BSD 3-Clause "New" or "Revised" License

73 stars 9 forks source link

Update docstring with original description of foreign variables #88

Closed rlange2 closed 4 years ago

rlange2 commented 4 years ago

This little addition replaces the Reference to variable 'some var' defined in class 'some class' in the docstring with the given description in the original process.

[x] Extends PR#67-Automatically generate Docstring
[x] Tests added
[x] Passes black . && flake8
[x] Fully documented, including whats-new.rst for all changes

benbovy commented 4 years ago

Thanks for adding this @rlange2 !

However, I don't think that is the best approach. Why not simply update foreing() in variable.py and set description with the description of the variable it refers to?

Also, as this issue is rather orthogonal to autodoc, it would be best to open a separate PR instead of extending #67.