Skip to content

Comments

Documentation: Clarified negating VCS excluded files#10442

Merged
radoering merged 1 commit intopython-poetry:mainfrom
couling:clarify-docs
Jun 28, 2025
Merged

Documentation: Clarified negating VCS excluded files#10442
radoering merged 1 commit intopython-poetry:mainfrom
couling:clarify-docs

Conversation

@couling
Copy link
Contributor

@couling couling commented Jun 20, 2025 •
edited
Loading

My earlier issue (#10418) was caused a misleading statement in the documentation which conflicts with a later statement:

Explicitly declaring entries in include will negate VCS' ignore settings.

As written, this is untrue because of the asymmetry between include and exclude:

If no format is specified, include defaults to only sdist.

In contrast, exclude defaults to both sdist and wheel.

So only declaring include entries with explicit formats can properly negate VCS.

To try to help future readers, I've moved the discussion of VCS down below the part on explicit formats so the closest code examples show explicit format, and clarified the note to inform readers the format must also be given.

Pull Request Check List

Resolves: #10418

  • Added tests for changed code. (NA.)
  • Updated documentation for changed code.

Summary by Sourcery

Documentation:

  • Move the VCS ignore note below the explicit formats section and update its wording to specify that format must be provided when using include to override VCS ignore settings.

@sourcery-ai
Copy link

sourcery-ai bot commented Jun 20, 2025 •
edited
Loading

Reviewer's Guide

Refines the pyproject.toml documentation by removing a misleading note and repositioning the VCS ignore discussion to clarify that negating VCS ignore settings via include requires explicitly specifying the format.

File-Level Changes

Change Details Files
Removed misleading documentation about negating VCS ignore settings without explicit formats
  • Deleted the existing note block asserting include entries negate VCS ignore settings
  • Removed the initial VCS seeding description under the exclude field
 docs/pyproject.md
Repositioned and clarified VCS ignore note with explicit format requirement
  • Moved the VCS seeding discussion below the explicit formats section
  • Added an updated note emphasizing that format must be set when using include to override VCS ignore
 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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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 Jun 20, 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 @couling - I've reviewed your changes and they look great!

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 Jun 28, 2025
@github-actions
Copy link

github-actions bot commented Jun 28, 2025

Deploy preview for website ready!

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

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

@radoering radoering merged commit 9a91531 into python-poetry:main Jun 28, 2025
55 checks passed
@couling couling deleted the clarify-docs branch June 28, 2025 21:17
@github-actions
Copy link

github-actions bot commented Jul 29, 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 Jul 29, 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

@radoering radoering radoering approved these changes

Assignees

No one assigned

Labels

impact/docs Contains or requires documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

VCS exclude overrides cannot be overrden by "include"

2 participants

@couling @radoering