Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
santisoler opened this issue Apr 16, 2024 · 0 comments · May be fixed by #492
Open

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

santisoler opened this issue Apr 16, 2024 · 0 comments · May be fixed by #492
Labels
bug Report a problem that needs to be fixed documentation Improvements or additions to documentation

Comments

@santisoler
Copy link
Member

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 santisoler added bug Report a problem that needs to be fixed documentation Improvements or additions to documentation labels Apr 16, 2024
@santisoler santisoler changed the title Attributes with trailing underscore are not properly shown in API Reference Attributes with trailing underscore are not properly shown in docs Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Report a problem that needs to be fixed documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant