Skip to content

Comments

Clarify that name and version fields are required in non-package mode if [project] is used#10033

Merged
abn merged 1 commit intopython-poetry:mainfrom
johnthagen:patch-1
Jan 14, 2025
Merged

Clarify that name and version fields are required in non-package mode if [project] is used#10033
abn merged 1 commit intopython-poetry:mainfrom
johnthagen:patch-1

Conversation

@johnthagen
Copy link
Contributor

@johnthagen johnthagen commented Jan 13, 2025 •
edited by sourcery-ai bot
Loading

Pull Request Check List

Resolves: #10031

Should be merged after this issue is fixed

Summary by Sourcery

Documentation:

  • Document that the name and version fields are always required if the project section is specified.

@sourcery-ai
Copy link

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

Reviewer's Guide by Sourcery

This PR clarifies that the name and version fields are required in the project table of the pyproject.toml file when not in package mode. It updates the documentation to reflect this requirement.

State diagram for pyproject.toml configuration requirements

stateDiagram-v2
    [*] --> ProjectConfig
    ProjectConfig --> PackageMode: package mode
    ProjectConfig --> NonPackageMode: non-package mode

    state PackageMode {
        [*] --> RequiredFields
        state RequiredFields {
            name
            version
        }
        RequiredFields --> OptionalFields
    }

    state NonPackageMode {
        [*] --> CheckProjectSection
        CheckProjectSection --> ProjectSectionUsed: using [project]
        CheckProjectSection --> AllOptional: not using [project]

        state ProjectSectionUsed {
            RequiredName: name required
            RequiredVersion: version required
        }
    }
Loading

File-Level Changes

Change Details Files
Clarified the requirements for the name and version fields in non-package mode
  • Added a sentence specifying that name and version are required in non-package mode if using the project section.
  • Updated the description of the version field to indicate that it's required when the project section is specified
 docs/pyproject.md

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

@johnthagen johnthagen mentioned this pull request Jan 13, 2025
Closed
sourcery-ai[bot]
sourcery-ai bot reviewed Jan 13, 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 @johnthagen - 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.

@abn abn added area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes labels Jan 13, 2025
@github-actions
Copy link

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

Deploy preview for website ready!

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

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

@abn abn enabled auto-merge (rebase) January 14, 2025 13:44
@abn abn merged commit 1e1e272 into python-poetry:main Jan 14, 2025
74 checks passed
@johnthagen johnthagen deleted the patch-1 branch January 14, 2025 13:49
@finswimmer finswimmer mentioned this pull request Feb 6, 2025
Merged
4 tasks
@github-actions
Copy link

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

@abn abn abn approved these changes

Assignees

No one assigned

Labels

area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

name field required for package-mode false after migrating to [project]

2 participants

@johnthagen @abn