harmonica icon indicating copy to clipboard operation
harmonica copied to clipboard

Attributes with trailing underscore are not properly shown in docs

Open santisoler opened this issue 2 months ago • 0 comments

Page that contains the error or needs to be improved (paste link): https://www.fatiando.org/harmonica/dev/api/generated/harmonica.EquivalentSources.html#harmonica.EquivalentSources

Description of the problem/suggestion:

In the list of Variables (Attributes) of the class, the points_, coefs_ and region_ attributes are shown without the trailing underscore.

Ideas to solve it

I suspect the issue is coming from napoleon: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

Useful link: https://stackoverflow.com/questions/72006651/napoleon-overescapes-trailing-underscore-in-parameter-name-leading-to-unknown-ta

santisoler avatar Apr 16 '24 18:04 santisoler