fatiando / harmonica

Forward modeling, inversion, and processing gravity and magnetic data
https://www.fatiando.org/harmonica
BSD 3-Clause "New" or "Revised" License
210 stars 69 forks source link

Attributes with trailing underscore are not properly shown in docs #490

Closed santisoler closed 4 months ago

santisoler commented 5 months ago

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