Skip to content

Docs: some references are ill formatted #238

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

Closed
rtavenar opened this issue May 20, 2020 · 3 comments
Closed

Docs: some references are ill formatted #238

rtavenar opened this issue May 20, 2020 · 3 comments

Comments

@rtavenar
Copy link
Member

rtavenar commented May 20, 2020

Is your feature request related to a problem? Please describe.
Some of the references are ill-formatted in the docs (because alignments are not set as expected by numpydoc I think), cf screenshot:
numpydoc

().

Describe the solution you'd like

EDIT: We would expect the ref numbering to be [1].
This seems to happen only where references are used in class docstrings (not in method docstrings for example)

This should be fixed everywhere needed. Help much appreciated!

@GillesVandewiele
Copy link
Contributor

Hi @rtavenar,

I will do this quickly! :)

@rtavenar
Copy link
Member Author

Hum, it seems this bug was due to numpydoc and by upgrading to version 1.0.0.dev0 does the trick (cf. latest docs). @GillesVandewiele I am really sorry that I wasted your time :/ I think I can close your PR, let me know if this is not the case.

@GillesVandewiele
Copy link
Contributor

That's no problem at all @rtavenar! You can indeed close the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants