Docs: Typo fixes

[tony]

Summary by Sourcery

Fix typos and improve clarity in various documentation sections.

Documentation:

• Fix typos across documentation files.
• Clarify installation instructions.
• Improve wording in developmental releases section.
• Correct inaccurate phrasing in pytest plugin documentation.
• Update type hints and fix references in pytest plugin examples.
• Correct the module reference in the migration guide

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request focuses on fixing typos and improving clarity across the documentation, including updates to installation instructions, explanations of versioning, and code examples. It also includes type hints to the my_git_repo fixture.

Updated class diagram for the my_git_repo fixture

classDiagram
    class CreateRepoPytestFixtureFn {
    }
    class Dict~str, Any~ {
    }
    class Path {
    }

    my_git_repo -- CreateRepoPytestFixtureFn : create_git_remote_repo
    my_git_repo -- Path : gitconfig
    my_git_repo -- Dict~str, Any~ : git_commit_envvars
    my_git_repo -- Path : return

Loading

File-Level Changes

Change	Details	Files
Corrected typos and improved clarity in the documentation.	Replaced $ pip install --user libvcs with $ python -m pip install libvcs. Replaced $ pip install --user --upgrade libvcs with $ python -m pip install --upgrade libvcs. Replaced 'versions you will see notification like a1, b1, and rc1' with 'versions, you will see notations like a1, b1, and rc1'. Added 'For example,' to the sentence about version notations. Replaced '- [pip]:' with 'Installation options:' and '- Via trunk (can break easily):' with '- Via trunk (development version, may be unstable):'. Replaced 'Patch $HOME to point to {func}user_path using ({func}set_home)' with 'Patch $HOME to point to {func}user_path using {func}set_home'. Added python to the code block example. Replaced 'Sometimes, set_getconfig via GIT_CONFIG doesn't apply as expected. For those' with 'Sometimes, set_gitconfig via GIT_CONFIG doesn't apply as expected. For those'. Added type hints to the my_git_repo fixture. Fixed the current module in migration.md	docs/quickstart.md docs/pytest-plugin.md docs/migration.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

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

Overall Comments:

• The changes look good, but it would be helpful to add a brief explanation of why python -m pip is preferred over pip.
• In pytest-plugin.md, the code block defining my_git_repo could benefit from a docstring explaining its purpose.

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.}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.09%. Comparing base (e3f8bee) to head (ef267cc).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #484   +/-   ##
=======================================
  Coverage   54.09%   54.09%           
=======================================
  Files          40       40           
  Lines        3627     3627           
  Branches      793      793           
=======================================
  Hits         1962     1962           
  Misses       1314     1314           
  Partials      351      351           

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