Open NLee-NREL opened 2 years ago
Unless the function is some class' __init__
constructor and the variables are attributes set upon self
(effectively becoming documented instance variables), this doesn't nor is it customary to work. Function-local variables are implementation details that don't need to be exposed in the docs, yet, with PEP-224 comments, they are still documented for the implementer reading the source.
Expected Behavior
I am trying to build documentation that would show the function and the variables contained in that function in the rendered documentation.
so with this function `def batteries():
"""This function blah blah
`
I would like the documentation to include
def batteries() description
Actual Behavior
however, my documentation only shows the functions, not the variables contained.
def batteries() description
Steps to Reproduce
Additional info