search

geodynamics / burnman

BurnMan is a library for modeling mantle thermodynamics and thermoelasticity constrained by mineral physics experiments.
https://geodynamics.github.io/burnman/
GNU General Public License v2.0
54 stars 41 forks source link

Docstrings: Argument names are smooshed together with argument types #529

Closed kaylai closed 1 year ago

kaylai commented 1 year ago

It seems in most (all?) of the autogenerated documentation from docstrings, the argument types are smooshed (this is a technical term) together with the argument type, so instead of

myarg float or

myarg
    float

you get myargfloat

which did confuse me quite a bit at fist in some cases!

In reference to: https://github.com/openjournals/joss-reviews/issues/5389

bobmyhill commented 1 year ago

Thanks @kaylai, this is now addressed by #541.