Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update to mention that project.name config is always required #9989

Merged

Conversation

franknarf8
Copy link
Contributor

@franknarf8 franknarf8 commented Jan 7, 2025

Pull Request Check List

Resolves: #9988

  • Added tests for changed code.
  • Updated documentation for changed code.

Summary by Sourcery

Documentation:

  • Clarify that the project.name configuration is always required when a project section is specified.

Copy link

sourcery-ai bot commented Jan 7, 2025

Reviewer's Guide by Sourcery

This pull request updates the documentation to reflect that the project.name config is always required when the project section is specified.

State diagram for project.name configuration requirement

stateDiagram-v2
    [*] --> CheckProjectSection
    CheckProjectSection --> NoNameRequired: No project section
    CheckProjectSection --> NameRequired: Has project section
    NoNameRequired --> [*]
    NameRequired --> [*]: Must specify project.name
Loading

File-Level Changes

Change Details Files
Clarified that the project.name config is always required if the project table is defined.
  • Updated the documentation to state that project.name is always required when the project section is specified.
  • Removed the text indicating that it was only required in package mode.
docs/pyproject.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

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

@radoering radoering added the impact/docs Contains or requires documentation changes label Jan 8, 2025
Copy link

github-actions bot commented Jan 8, 2025

Deploy preview for website ready!

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

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

@radoering radoering merged commit 019cb53 into python-poetry:main Jan 8, 2025
75 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact/docs Contains or requires documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Poetry 2.0 requires a "project.name" config even if "package-mode" is set
2 participants