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

Update basic-usage to reflect new default to src layout #10203

Merged

Conversation

adithyaappu
Copy link
Contributor

@adithyaappu adithyaappu commented Feb 19, 2025

Update Documentation

The change in default folder layout when a new project is created, was not updated in the Basic Usage section of documentation. This just updates the structure with the folder layout from the CLI reference.

Pull Request Check List

Resolves: #10135

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

Summary by Sourcery

Documentation:

  • Update the basic usage documentation to reflect the new default src layout for new projects.

python-poetry#10135 The change in folder layout when new project is created, was not updated in the `Basic Usage` documentation. This just updates the structure with the folder layout from the CLI reference.
Copy link

sourcery-ai bot commented Feb 19, 2025

Reviewer's Guide by Sourcery

The documentation for basic usage was updated to reflect the new default project layout that includes a src directory. This change ensures that the documentation aligns with the current project structure generated by the CLI.

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

File-Level Changes

Change Details Files
Updated the basic usage documentation to reflect the new default src layout for new projects.
  • Modified the directory structure in the basic usage example to include the src directory.
  • Adjusted the path for the poetry_demo package to be within the src directory.
docs/basic-usage.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. 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!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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 @adithyaappu - I've reviewed your changes - here's some feedback:

Overall Comments:

  • This change looks good, thanks for keeping the documentation up to date.
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 merged commit 79c207b into python-poetry:main Feb 19, 2025
53 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants