Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Docs: Typo fixes#484

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
tony wants to merge15 commits intomaster
base:master
Choose a base branch
Loading
fromdoc-improvements
Open

Docs: Typo fixes#484

tony wants to merge15 commits intomasterfromdoc-improvements

Conversation

@tony
Copy link
Member

@tonytony commentedFeb 17, 2025•
edited by sourcery-aibot
Loading

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
Copy link

sourcery-aibot commentedFeb 17, 2025•
edited
Loading

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 themy_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

ChangeDetailsFiles
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 likea1,b1, andrc1' with 'versions, you will see notations likea1,b1, andrc1'.
  • 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'.
  • Addedpython to the code block example.
  • Replaced 'Sometimes,set_getconfig viaGIT_CONFIG doesn't apply as expected. For those' with 'Sometimes,set_gitconfig viaGIT_CONFIG doesn't apply as expected. For those'.
  • Added type hints to themy_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 yourdashboard 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-aisourcery-aibot 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:

  • The changes look good, but it would be helpful to add a brief explanation of whypython -m pip is preferred overpip.
  • Inpytest-plugin.md, the code block definingmy_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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

sourcery-ai[bot] reacted with thumbs up emojisourcery-ai[bot] reacted with thumbs down emoji
@tonytonyforce-pushed thedoc-improvements branch 4 times, most recently fromd25926b tob12e1e2CompareFebruary 22, 2025 15:56
@codecov
Copy link

codecovbot commentedFeb 22, 2025•
edited
Loading

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.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

1 more reviewer

@sourcery-aisourcery-ai[bot]sourcery-ai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tony
[8]ページ先頭
©2009-2025 Movatter.jp