Skip to content

Conversation

@vidit-maheshwari
Copy link

@vidit-maheshwari vidit-maheshwari commented Dec 12, 2025

Closes #176

📝 Description

This PR updates the documentation to remove the outdated --no-update flag from the poetry lock command.
In Poetry 2.x, this flag has been removed, but the documentation still referenced it, causing the following error for users

🔧 Changes Made

Replaced poetry lock --no-update with poetry lock

📷 Screenshots or Visual Changes (if applicable)

NA

🤝 Collaboration

NA

✅ Checklist

  • I have read the contributing guidelines.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added necessary documentation (if applicable).
  • Any dependent changes have been merged and published in downstream modules.

Summary by CodeRabbit

  • Documentation
    • Updated the installation guide to allow automatic lockfile updates during Python dependency resolution, enabling more flexible dependency management during setup.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 12, 2025

Walkthrough

Updated documentation to remove the deprecated --no-update flag from the poetry lock command in the installation guide, aligning with Poetry 2.2.x compatibility where this option no longer exists.

Changes

Cohort / File(s) Summary
Documentation Update
docs/INSTALL_GUIDE.md
Updated Poetry dependency locking command from poetry lock --no-update to poetry lock to reflect Poetry 2.2.x CLI compatibility

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰 A flag that vanished in the night,
Poetry's --no-update took flight,
Docs now gleam with modern grace,
poetry lock holds its place! ✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: removing the outdated --no-update flag from documentation to align with Poetry 2.x requirements.
Linked Issues check ✅ Passed The pull request directly addresses issue #176 by removing the --no-update flag from docs/INSTALL_GUIDE.md to reflect Poetry 2.x behavior, meeting all specified coding objectives.
Out of Scope Changes check ✅ Passed The changes are limited to docs/INSTALL_GUIDE.md and involve only the removal of the --no-update flag, which is directly aligned with issue #176 requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8eeacad and fcb3e97.

📒 Files selected for processing (1)
  • docs/INSTALL_GUIDE.md (1 hunks)
🔇 Additional comments (1)
docs/INSTALL_GUIDE.md (1)

36-36: Good fix for Poetry 2.x compatibility.

The removal of the --no-update flag is correct; this flag was removed in Poetry 2.x. The line 30 verification step already sets the expectation for v2.0.0+, which provides adequate context. The command sequence (env setup → lock → install) is logically sound.

Optional enhancement: Consider adding a brief note in the step commentary to clarify the version change for users migrating from Poetry 1.x, e.g., "Note: The --no-update flag was removed in Poetry 2.x; use poetry lock instead." This would make the breaking change more visible to users.


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.

@vidit-maheshwari
Copy link
Author

@smokeyScraper @chandansgowda Have a look at this, not a major change and can be merged easily.

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.

DOCS UPDATE: Command "poetry lock --no-update" missing in Poetry 2.2.x documentation

1 participant