libvcs
libvcs copied to clipboard
Docs: Typo fixes
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
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
File-Level Changes
| Change | Details | Files |
|---|---|---|
| Corrected typos and improved clarity in the documentation. |
|
docs/quickstart.mddocs/pytest-plugin.mddocs/migration.md |
Tips and commands
Interacting with Sourcery
- Trigger a new review: Comment
@sourcery-ai reviewon 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 issueto create an issue from it. - Generate a pull request title: Write
@sourcery-aianywhere in the pull request title to generate a title at any time. You can also comment@sourcery-ai titleon the pull request to (re-)generate the title at any time. - Generate a pull request summary: Write
@sourcery-ai summaryanywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment@sourcery-ai summaryon the pull request to (re-)generate the summary at any time. - Generate reviewer's guide: Comment
@sourcery-ai guideon the pull request to (re-)generate the reviewer's guide at any time. - Resolve all Sourcery comments: Comment
@sourcery-ai resolveon 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 dismisson 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 reviewto trigger a new review! - Generate a plan of action for an issue: Comment
@sourcery-ai planon 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.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
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
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.