Skip to content

Bump sphinx-autodoc-typehints from 3.1.0 to 3.6.2#316

Closed
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/sphinx-autodoc-typehints-3.6.2
Closed

Bump sphinx-autodoc-typehints from 3.1.0 to 3.6.2#316
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/sphinx-autodoc-typehints-3.6.2

Conversation

@dependabot
Copy link
Copy Markdown
Contributor

@dependabot dependabot Bot commented on behalf of github Jan 6, 2026

Bumps sphinx-autodoc-typehints from 3.1.0 to 3.6.2.

Release notes

Sourced from sphinx-autodoc-typehints's releases.

3.6.2

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.6.1...3.6.2

3.6.1

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.6.0...3.6.1

3.6.0

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.5.2...3.6.0

3.5.2

What's Changed

New Contributors

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.5.1...3.5.2

3.5.1

What's Changed

Full Changelog: tox-dev/sphinx-autodoc-typehints@3.5.0...3.5.1

3.5.0

... (truncated)

Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python python programming languagae labels Jan 6, 2026
@dependabot dependabot Bot requested a review from a team as a code owner January 6, 2026 22:13
@dependabot dependabot Bot added python python programming languagae dependencies Pull requests that update a dependency file labels Jan 6, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 6, 2026

🤖 Claude Code Review

Code Review Analysis

Code Quality

Code follows style guide: The change is a dependency version update in a configuration file. The formatting follows standard TOML conventions and is consistent with the rest of the file.

No commented-out code: No commented code present.

Meaningful variable names: N/A - This is a dependency version update.

DRY principle followed: N/A - Single line change in dependency specification.

Identify Defects: No defects identified. This is a straightforward dependency version bump from 3.1.0 to 3.6.2 for sphinx-autodoc-typehints. The change maintains the same Python version constraint (> '3.11').

Project memory configuration: N/A - This change doesn't conflict with any project-specific conventions.

Testing

⚠️ Unit tests for new functions: N/A - No functional code changes, only dependency update.

⚠️ Integration tests for new endpoints: N/A - No new endpoints.

⚠️ Edge cases covered: N/A - Dependency update only.

Test coverage > 80%: Cannot verify from diff alone. Recommend running tests to ensure the updated dependency doesn't break existing documentation builds. The version jump from 3.1.0 to 3.6.2 spans several minor versions and could introduce breaking changes in type hint rendering.

Recommendation:

  • Run pip install -e ".[documentation]" and build documentation locally
  • Verify Sphinx documentation builds successfully with the new version
  • Check for any changes in type hint rendering

Documentation

⚠️ Readme updated if needed: N/A for dependency updates unless there are breaking changes in usage.

⚠️ API docs updated: Should verify that documentation builds correctly with the new version.

⚠️ Inline comments for complex logic: N/A - Configuration file.

CHANGELOG.md updated: Not visible in the diff. Dependency updates should typically be documented in CHANGELOG.md to track version changes.

⚠️ Markdown formatting: N/A - No markdown files changed.

Security

No hardcoded credentials: None present.

Input validation implemented: N/A - Configuration change only.

Proper error handling: N/A - Configuration change only.

No sensitive data in logs: N/A - Configuration change only.

No license files (.lic) or AQAAAD strings: None present in the diff.


Summary

This is a low-risk dependency update for a documentation tool. The primary concerns are:

  1. Missing CHANGELOG entry - Dependency updates should be tracked (pyproject.toml:61)
  2. Testing recommendation - The 5-patch version jump (3.1.0 → 3.6.2) should be validated by building documentation locally to ensure no rendering issues

Action Items:

  • Update CHANGELOG.md with this dependency version change
  • Build Sphinx documentation locally to verify compatibility
  • Check if type hint rendering has any visual/functional changes

Overall Assessment: ✅ APPROVED with recommendation to verify documentation builds and update CHANGELOG.

Automated code review analyzing defects and coding standards

Bumps [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints) from 3.1.0 to 3.6.2.
- [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases)
- [Commits](tox-dev/sphinx-autodoc-typehints@3.1.0...3.6.2)

---
updated-dependencies:
- dependency-name: sphinx-autodoc-typehints
  dependency-version: 3.6.2
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot force-pushed the dependabot/pip/sphinx-autodoc-typehints-3.6.2 branch from 70179ba to 29178a5 Compare January 6, 2026 22:28
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jan 6, 2026

🤖 Claude Code Review

CHANGELOG.md not updated - /home/runner/work/sz-python-tools/sz-python-tools/pyproject.toml:61

  • The CHANGELOG.md exists and is actively maintained with an [Unreleased] section.
  • Dependency updates, especially those in the documentation group, are typically documented. This should have an entry under [Unreleased] such as:
    ### Changed in Unreleased
    - Updated sphinx-autodoc-typehints from 3.1.0 to 3.6.2 for Python > 3.11

⚠️ Markdown formatting

  • The CHANGELOG.md appears properly formatted, but this change doesn't involve markdown file modifications.

Security

No hardcoded credentials

  • No credentials present in the diff.

Input validation implemented

  • N/A - This is a dependency version update.

Proper error handling

  • N/A - No code changes.

No sensitive data in logs

  • N/A - No logging changes.

No license files (.lic) or AQAAAD strings

  • No license files or sensitive license strings detected in the diff.

Summary

Overall Assessment: ✅ Acceptable with minor improvement

This is a clean dependency version update with no major issues. The change is low-risk as it only affects documentation generation tooling.

Required Action:

  • Update CHANGELOG.md - Add an entry under the [Unreleased] section documenting this dependency update.

Recommendations:

  • Verify that documentation builds successfully with the new version (ideally through CI/CD).
  • Consider reviewing the release notes for sphinx-autodoc-typehints versions 3.1.0 → 3.6.2 to understand what changes are included.

Automated code review analyzing defects and coding standards

@docktermj docktermj self-assigned this Jan 7, 2026
@docktermj docktermj enabled auto-merge (squash) January 7, 2026 14:13
@dependabot @github
Copy link
Copy Markdown
Contributor Author

dependabot Bot commented on behalf of github Jan 7, 2026

Looks like sphinx-autodoc-typehints is no longer updatable, so this is no longer needed.

@dependabot dependabot Bot closed this Jan 7, 2026
auto-merge was automatically disabled January 7, 2026 23:31

Pull request was closed

@dependabot dependabot Bot deleted the dependabot/pip/sphinx-autodoc-typehints-3.6.2 branch January 7, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python python programming languagae

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants