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

Fix some documentation formatting #946

Merged
merged 3 commits into from
Jun 10, 2022
Merged

Conversation

abergeron
Copy link
Collaborator

Description

Fix some formatting in the docs to avoid missing sections and weirdly formatted arguments list.

Changes

  1. Using custom section is bad because sphinx skips them and doesn't show anything in the rendered docs.
  2. Typos in the section names are bad for the same reason.
  3. arg : type renders as argtype
    arg: type renders as arg: type

Checklist

Tests

  • I added corresponding tests for bug fixes and new features. If possible, the tests fail without the changes
  • All new and existing tests are passing ($ tox -e py38; replace 38 by your Python version if necessary)

Documentation

  • I have updated the relevant documentation related to my changes

Quality

  • I have read the CONTRIBUTING doc
  • My commits messages follow this format
  • My code follows the style guidelines ($ tox -e lint)

Further comments

As a general comment, the docstrings seems to use at least two different markup standards (I have seen numpydoc and reST) often in the same file.

It would be good to standardize on one style and try to enforce it and it may help with odd formatting that may be caused by the doc parser getting confused by the different styles.

@abergeron abergeron changed the title Fix docs Fix some documentation formatting Jun 9, 2022
@bouthilx
Copy link
Member

Thanks for the fixes! There are indeed inconsistencies. Numpy format is the one we favor for this project.

@bouthilx bouthilx merged commit d8f500e into Epistimio:develop Jun 10, 2022
@notoraptor notoraptor mentioned this pull request Aug 2, 2022
@bouthilx bouthilx added the documentation Regarding description, documentation, tutorials, etc label Aug 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Regarding description, documentation, tutorials, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants