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

chore(doc): update Prezto completion #10070

Merged
merged 1 commit into from
Jan 18, 2025

Conversation

abn
Copy link
Member

@abn abn commented Jan 17, 2025

Closes: #8607

Summary by Sourcery

Documentation:

  • Add a note about restarting the shell for tab completion changes to take effect.

Copy link

sourcery-ai bot commented Jan 17, 2025

Reviewer's Guide by Sourcery

This pull request updates the documentation for Prezto completion, providing a more robust solution for users who have issues with the initial setup.

Flow diagram for Poetry Prezto completion troubleshooting

flowchart TD
    A[Start] --> B[Run completion command]
    B --> C[Save to Prezto path]
    C --> D{Completions working?}
    D -->|Yes| E[Done]
    D -->|No| F[Remove zcompcache]
    F --> G[Start new shell]
    G --> D
Loading

File-Level Changes

Change Details Files
Updated the Prezto completion instructions to include a troubleshooting step.
  • Added a note to remove ~/.cache/prezto/zcompcache if completions don't work.
docs/_index.md
Moved the note about restarting the shell to be before the shell specific instructions.
  • Moved the note about restarting the shell to be before the shell specific instructions.
docs/_index.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

@abn abn added the impact/docs Contains or requires documentation changes label Jan 17, 2025
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 @abn - 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.

Copy link

Deploy preview for website ready!

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

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

@abn abn requested a review from a team January 17, 2025 21:51
@abn abn merged commit db25987 into python-poetry:main Jan 18, 2025
75 checks passed
@abn abn deleted the fork/predmijat/patch-1 branch January 18, 2025 00:44
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.

3 participants