Skip to content

Comments

doc(faq): add entry for PEP 621 migration#9996

Merged
abn merged 1 commit intopython-poetry:mainfrom
abn:docs/add-migration-faq
Jan 9, 2025
Merged

doc(faq): add entry for PEP 621 migration#9996
abn merged 1 commit intopython-poetry:mainfrom
abn:docs/add-migration-faq

Conversation

@abn
Copy link
Member

@abn abn commented Jan 8, 2025 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Documentation:

  • Add a new FAQ entry detailing the migration process from the tools.poetry section to the project section in pyproject.toml as per PEP 621.

@abn abn added area/docs/faq Frequently duplicated/potential addition to FAQ impact/docs Contains or requires documentation changes labels Jan 8, 2025
@abn abn requested a review from a team January 8, 2025 15:25
@sourcery-ai
Copy link

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

Reviewer's Guide by Sourcery

This pull request adds a comprehensive FAQ entry in the documentation to guide users on migrating their Poetry projects from the 'tools.poetry' section to the new 'project' section as outlined in PEP 621. It includes examples and notes on handling dynamic and static dependencies.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new FAQ entry for migrating an existing Poetry project to use the new 'project' section as per PEP 621.
  • Introduced a new FAQ section explaining the migration process from 'tools.poetry' to 'project' section.
  • Provided a detailed example of the original 'pyproject.toml' configuration using 'tools.poetry'.
  • Included examples of 'pyproject.toml' configurations using dynamic and static dependencies under the 'project' section.
  • Added notes explaining the dynamic properties for 'classifiers' and 'dependencies', and the replacement of 'python' dependency with 'project.requires-python'.
  • Highlighted the addition of 'requires-poetry' in the 'tools.poetry' section.
 docs/faq.md
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 8, 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 @abn - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 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.

@github-actions
Copy link

github-actions bot commented Jan 8, 2025 •
edited
Loading

Deploy preview for website ready!

✅ Preview
https://website-gxvawal8c-python-poetry.vercel.app

Built with commit 03006eb.
This pull request is being automatically deployed with vercel-action

@abn abn force-pushed the docs/add-migration-faq branch from 0dd07b0 to adb340c Compare January 8, 2025 15:34
finswimmer
finswimmer requested changes Jan 9, 2025
View reviewed changes
Copy link
Member

@finswimmer finswimmer left a comment

Choose a reason for hiding this comment

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

I like 👍 Just one minor thing.

@abn abn force-pushed the docs/add-migration-faq branch from adb340c to 03006eb Compare January 9, 2025 15:14
@abn abn requested a review from finswimmer January 9, 2025 15:14
@abn abn enabled auto-merge (rebase) January 9, 2025 15:18
@abn abn merged commit 2d7d173 into python-poetry:main Jan 9, 2025
74 checks passed
@abn abn deleted the docs/add-migration-faq branch January 9, 2025 15:45
@radoering radoering mentioned this pull request Jan 11, 2025
Merged
@github-actions
Copy link

github-actions bot commented Feb 9, 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 9, 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

@finswimmer finswimmer finswimmer approved these changes

Assignees

No one assigned

Labels

area/docs/faq Frequently duplicated/potential addition to FAQ impact/docs Contains or requires documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@abn @finswimmer