Skip to content

Pin astroid version below 4.0.0 to fix docs - #3598

Merged
Starbuck5 merged 1 commit into
pygame-community:mainfrom
oddbookworm:fix-docs-by-pinning-astroid
Oct 6, 2025
Merged

Starbuck5 merged 1 commit into
pygame-community:mainfrom
oddbookworm:fix-docs-by-pinning-astroid

Conversation

@oddbookworm

Copy link
Copy Markdown
Member

Docs currently broken due to astroid 4.0.0 installed by sphinx. Pinning below that to fix the docs generation for now

@coderabbitai

coderabbitai Bot commented Oct 6, 2025 •

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Added a version constraint for astroid in the build-system requirements in pyproject.toml, specifying astroid<4.0.0. No other files or logic were changed.

Changes

Cohort / File(s) Summary
Build system dependencies
`pyproject.toml`
Added dependency constraint in `build-system.requires`: `astroid<4.0.0`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title concisely summarizes the main technical change by specifying that the astroid dependency is pinned below version 4.0.0. It also highlights the purpose of the change, which is to fix documentation generation. This phrasing is clear and specific enough for a reviewer to understand the scope of the PR at a glance.
Description Check ✅ Passed The description clearly explains why the pin is necessary, noting that documentation generation was broken due to astroid 4.0.0 being installed by Sphinx. It directly relates to the changeset by referencing both the problem and the temporary fix. The explanation provides sufficient context for reviewers to understand the rationale even without additional detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 52034ca and 2418b95.

📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: build (windows-latest)
  • GitHub Check: build (macos-14)
  • GitHub Check: build (ubuntu-24.04)
  • GitHub Check: Debian (Bookworm - 12) [armv6]
  • GitHub Check: Debian (Bookworm - 12) [armv7]
  • GitHub Check: Debian (Bookworm - 12) [s390x]
  • GitHub Check: Debian (Bookworm - 12) [ppc64le]
  • GitHub Check: debug_coverage (ubuntu-24.04, 3.13.5)
  • GitHub Check: debug_coverage (ubuntu-24.04, 3.14.0rc1)
  • GitHub Check: debug_coverage (ubuntu-24.04, 3.9.23)
  • GitHub Check: AMD64
  • GitHub Check: build (ubuntu-22.04)
  • GitHub Check: x86
  • GitHub Check: dev-check
  • GitHub Check: msys2 (ucrt64, ucrt-x86_64)
  • GitHub Check: msys2 (clang64, clang-x86_64)
  • GitHub Check: x86_64
  • GitHub Check: i686
  • GitHub Check: aarch64
  • GitHub Check: msys2 (mingw64, x86_64)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Starbuck5

Copy link
Copy Markdown
Member

CC @zoldalma999

@Starbuck5
Starbuck5 merged commit c5b66aa into pygame-community:main Oct 6, 2025
1 check was pending
@ankith26 ankith26 added this to the 2.5.6 milestone Oct 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants