Skip to content

Comments

docs/cli: Fix typo in export section to allow poetry-plugin-export at latest version 1.8#9954

Merged
Secrus merged 2 commits intopython-poetry:mainfrom
yongjiajun:patch-1
Jan 8, 2025
Merged

docs/cli: Fix typo in export section to allow poetry-plugin-export at latest version 1.8#9954
Secrus merged 2 commits intopython-poetry:mainfrom
yongjiajun:patch-1

Conversation

@yongjiajun
Copy link
Contributor

@yongjiajun yongjiajun commented Jan 6, 2025 •
edited by sourcery-ai bot
Loading

Resolves #9953

This PR fixes a typo in the export section of the CLI (Commands) documentation page, allowing poetry-plugin-export to be installed at its latest version, 1.8.

Summary by Sourcery

Documentation:

  • Correct the minimum required version of the poetry-plugin-export plugin in the CLI documentation.

@sourcery-ai
Copy link

sourcery-ai bot commented Jan 6, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request fixes a typo in the export section of the CLI documentation, changing the poetry-plugin-export version requirement from >1.8 to >=1.8. This allows users to install the plugin at version 1.8.

State diagram showing version constraint change for poetry-plugin-export

stateDiagram-v2
    [*] --> Before: >1.8
    Before --> After: Fix typo
    After: >=1.8
    After --> [*]
Loading

File-Level Changes

Change Details Files
Fixed a typo in the version requirement
  • Changed the poetry-plugin-export version requirement in the pyproject.toml example from >1.8 to >=1.8
 docs/cli.md

Assessment against linked issues

Issue Objective Addressed Explanation
#9953 Correct the typo in the documentation for poetry-plugin-export version requirement from '>1.8' to '>=1.8' ✅

Possibly linked issues

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 6, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @yongjiajun - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Secrus
Secrus reviewed Jan 6, 2025
View reviewed changes
@yongjiajun yongjiajun requested a review from Secrus January 7, 2025 02:12
@Secrus Secrus enabled auto-merge (squash) January 8, 2025 09:09
@Secrus Secrus merged commit b4d3526 into python-poetry:main Jan 8, 2025
73 checks passed
@yongjiajun yongjiajun deleted the patch-1 branch January 8, 2025 09:29
@radoering radoering mentioned this pull request Jan 11, 2025
Merged
@github-actions
Copy link

github-actions bot commented Feb 8, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

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

docs/cli: Typo in export section, preventing latest version of poetry-plugin-export (1.8) from being installed

2 participants

@yongjiajun @Secrus