chianti-atomic / ChiantiPy

ChiantiPy is a python package to calculate the radiative properties of astrophysical plasmas based on the CHIANTI atomic database
64 stars 31 forks source link

Possible typo in function's documentation #427

Closed AlexandrosKoukras closed 1 year ago

AlexandrosKoukras commented 1 year ago

Hello,

I was looking at the function intensityRatioInterpolate in chiantipy/chianti/core/Ion.py and it seems to me that in the documentation of the function there is a typo. It's written:

'to take a set of date and interpolate against the IntensityRatio'

But I believe it meant to be 'data' and not 'date'. If that is not the case, can you let me know to what this 'date' refers? In case that it is indeed a typo, I can make a commit to change it.

Lastly, wouldn't it be better to have a more detail description of the 'data' argument in the description of this function?

kdere commented 1 year ago

Yes, date should be data and the docstring could be more informative. What is supposed to do is take list/array of measured density ratio and return the density corresponding to the intensity ratio