Skip to content

docs: update docstrings to resolve sphinx failures#1030

Merged
codejedi365 merged 1 commit intopython-semantic-release:masterfrom
wyardley:wyardley/docs/tidy
Sep 25, 2024
Merged

docs: update docstrings to resolve sphinx failures#1030
codejedi365 merged 1 commit intopython-semantic-release:masterfrom
wyardley:wyardley/docs/tidy

Conversation

@wyardley
Copy link
Copy Markdown
Contributor

Purpose

Fixes #1029

Rationale

Happy to do this differently, but Sphinx style seemed to match most of what we had in the codebase

Pros:

  • Types are inferred automagically
  • A bit easier for machine parsing
  • Slightly smaller footprint

Cons:

  • A bit harder to read directly in the code (no types, etc.)
  • No ruff support for setting pydocstyle to sphinx.

How did you test?

Generated locally and spot-checked that at least type inferences etc. seemed to work Ok.

Note: references to errors raised / types from other libraries aren't automagically linked; I assume that's Ok.

How to Verify

Build docs following docs in contributing guidelines, and view in browser

Fixes python-semantic-release#1029

- set `ignore-module-all` for `autodoc_default_options` to resolve some
  Sphinx errors about duplicate / ambiguous references
  sphinx-doc/sphinx#4961 (comment)
- Standardize some non-standard (Google-ish) docstrings to Sphinx
  format, to avoid ruff and Sphinx arguing about underline length.
- Fix indents and other minor whitespace / formatting changes.
@codejedi365 codejedi365 merged commit d84efc7 into python-semantic-release:master Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc style preference

2 participants