Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: update docstrings to resolve sphinx failures#1030

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

@wyardley
Copy link
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 settingpydocstyle tosphinx.

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

Fixespython-semantic-release#1029- set `ignore-module-all` for `autodoc_default_options` to resolve some  Sphinx errors about duplicate / ambiguous referencessphinx-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.
@codejedi365codejedi365 merged commitd84efc7 intopython-semantic-release:masterSep 25, 2024
8 checks passed
This was referencedFeb 5, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@codejedi365codejedi365codejedi365 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Doc style preference

2 participants

@wyardley@codejedi365

[8]ページ先頭

©2009-2025 Movatter.jp