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

Doc / typos fixes #569

Merged
merged 35 commits into from
Feb 17, 2025
Merged

Doc / typos fixes #569

merged 35 commits into from
Feb 17, 2025

Conversation

tony
Copy link
Member

@tony tony commented Feb 17, 2025

Summary by Sourcery

Improve the clarity and consistency of the documentation by fixing typos, clarifying explanations, and updating examples.

Bug Fixes:

  • Fix typos in documentation
  • Clarify some concepts and wording

Documentation:

  • Update command examples with console blocks for better readability
  • Improve explanations of core concepts and relations between objects
  • Clarify the usage of unique identifiers for sessions, windows, and panes
  • Fix broken links and references

Copy link

sourcery-ai bot commented Feb 17, 2025

Reviewer's Guide by Sourcery

This pull request focuses on enhancing the documentation by fixing typos, improving formatting, and updating external links. The changes aim to improve the clarity and accuracy of the documentation, making it easier for users and developers to understand and use the library.

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

File-Level Changes

Change Details Files
Corrected typos and improved formatting in the documentation.
  • Fixed typos across multiple documentation files.
  • Improved readability by adding console code blocks for commands.
  • Updated references and links to external resources.
docs/developing.md
docs/about.md
docs/pytest-plugin/index.md
docs/quickstart.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

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.84%. Comparing base (9097ace) to head (7336059).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #569   +/-   ##
=======================================
  Coverage   88.84%   88.84%           
=======================================
  Files          36       36           
  Lines        4080     4080           
  Branches      376      376           
=======================================
  Hits         3625     3625           
  Misses        310      310           
  Partials      145      145           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tony added 25 commits February 17, 2025 08:16
@tony tony marked this pull request as ready for review February 17, 2025 14:43
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 @tony - I've reviewed your changes - here's some feedback:

Overall Comments:

  • It looks like you've converted some commands to code blocks, which is great for readability and copy-pasting, but ensure the commands are still accurate and up-to-date.
  • Thanks for fixing the typos and improving the documentation!
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.

@tony tony merged commit e2bbf72 into master Feb 17, 2025
27 checks passed
@tony tony deleted the doc-improvements branch February 17, 2025 14:47
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.

1 participant