Skip to content

Fix #310: Correct API documentation #311

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

Merged
merged 1 commit into from
Nov 4, 2020

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Nov 3, 2020

This PR fixes #310 and contains:

  • Remove all automatic generation and use a more "semi-manual" approach (gives more control)
  • Improve docstrings in semver module
  • Remove docstrings in some dunder methods; Sphinx and autodoc uses the docstring from the parent class
  • Remove sphinx-apidoc command from tox.ini

@tomschr tomschr added Bug Error, flaw or fault to produce incorrect or unexpected results Doc Documentation related issue labels Nov 3, 2020
@tomschr tomschr requested a review from a team November 3, 2020 18:43
@tomschr tomschr self-assigned this Nov 3, 2020
* Remove all automatic generation and use a more
  "semi-manual" approach (gives more control)
* Improve docstrings in semver module
* Remove docstrings in some dunder methods; Sphinx
  and autodoc uses the docstring from the parent class
* Remove sphinx-apidoc command from :file:`tox.ini`
@tomschr tomschr force-pushed the bugfix/310-api-doc branch from b965788 to dcdcd2a Compare November 3, 2020 20:23
@tomschr tomschr merged commit 073e314 into python-semver:master Nov 4, 2020
@tomschr tomschr deleted the bugfix/310-api-doc branch November 4, 2020 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Error, flaw or fault to produce incorrect or unexpected results Doc Documentation related issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix API documentation
1 participant