Skip to content

build(deps): Lock snowballstemmer to v2.* to work around #886.#887

Merged
kirkrodrigues merged 1 commit intoy-scope:mainfrom
kirkrodrigues:mitigate-886
May 8, 2025
Merged

build(deps): Lock snowballstemmer to v2.* to work around #886.#887
kirkrodrigues merged 1 commit intoy-scope:mainfrom
kirkrodrigues:mitigate-886

Conversation

@kirkrodrigues
Copy link
Copy Markdown
Member

@kirkrodrigues kirkrodrigues commented May 8, 2025 •
edited by coderabbitai bot
Loading

Description

As the title says, this mitigates #886 until a fix is available for sphinx-doc/sphinx#13533.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Workflows succeed.

Summary by CodeRabbit

  • Chores
    • Added the snowballstemmer dependency to documentation requirements to address a known compatibility issue.

@kirkrodrigues kirkrodrigues requested a review from a team as a code owner May 8, 2025 10:25
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 8, 2025 •
edited
Loading

Walkthrough

A new dependency, snowballstemmer (version 2.*), has been added to the docs/requirements.txt file as a workaround for a documented Sphinx issue. No other files or dependencies were changed.

Changes

File(s) Change Summary
docs/requirements.txt Added snowballstemmer~=2.2 as a workaround for a known Sphinx documentation issue.

Suggested reviewers

  • LinZhihao-723

Tip

⚡️ Faster reviews with caching
  • CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed May 8, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3424d2a and c4694a5.

📒 Files selected for processing (1)
  • docs/requirements.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: lint-check (macos-latest)
  • GitHub Check: lint-check (ubuntu-latest)
🔇 Additional comments (1)
docs/requirements.txt (1)

9-9: Approve dependency pinning to avoid Sphinx issue.
Locking snowballstemmer to the 2.* series correctly avoids the compatibility break introduced in newer versions. Docs build workflows have passed, so this change aligns with the PR objective.

docs/requirements.txt
sphinx-copybutton>=0.5.2
sphinxcontrib-mermaid>=1.0.0

# Lock to v2.* to work around https://github.com/sphinx-doc/sphinx/issues/13533
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Nitpick: Clarify temporary nature of the workaround.
Please prefix the comment with “TODO:” or “Temporary:” to indicate this lock is short-lived. For example:

- # Lock to v2.* to work around https://github.com/sphinx-doc/sphinx/issues/13533
+ # TODO: temporary lock to snowballstemmer v2.* as a workaround for https://github.com/sphinx-doc/sphinx/issues/13533; remove once resolved upstream
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Lock to v2.* to work around https://github.com/sphinx-doc/sphinx/issues/13533
# TODO: temporary lock to snowballstemmer v2.* as a workaround for https://github.com/sphinx-doc/sphinx/issues/13533; remove once resolved upstream

@kirkrodrigues kirkrodrigues merged commit 585555f into y-scope:main May 8, 2025
7 checks passed
@kirkrodrigues kirkrodrigues deleted the mitigate-886 branch May 8, 2025 14:19
@coderabbitai coderabbitai bot mentioned this pull request May 20, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@davidlion davidlion davidlion 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.

2 participants

@kirkrodrigues @davidlion