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

[johnthagen]

Pull Request Check List

Resolves: #10031

Should be merged after this issue is fixed

• version field not required in [project] table when package-mode = false #10032

Summary by Sourcery

Documentation:

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

[sourcery-ai]

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

• name field required for package-mode false after migrating to [project] #10031: The PR clarifies the documentation regarding the "name" field requirement in non-package mode, addressing the issue raised.

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

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