Skip to content

docs: fix 3 typos in docstrings and setup.py URL - #10

Merged
ericbsd merged 1 commit into
ghostbsd:masterfrom
Avicennasis:docs/fix-typos
Sep 22, 2026
Merged

ericbsd merged 1 commit into
ghostbsd:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

@Avicennasis Avicennasis commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Fix typo issues across 2 files:

  • bectl.py: two docstring verb-agreement fixes ("unmount"→"unmounts", "check"→"checks", matching the pattern already used by the other function docstrings in this file)
  • setup.py: broken project URL — https://github/GhostBSD/pybectl/ was missing .com

Note: the original scan also flagged 5 other docstring verb-agreement typos in this file, but those have already been fixed upstream since the scan ran — only the 2 above are still present in main.

No functional changes — comments/documentation only.

Summary by Sourcery

Correct documentation wording and the project homepage URL without changing runtime behavior.

Bug Fixes:

  • Correct the project URL in package metadata so it points to the valid GitHub address.

Enhancements:

  • Fix grammatical agreement in two bectl.py function docstrings.

Signed-off-by: Léon "Avic" Simmons <avicennasis@gmail.com>
@Avicennasis
Avicennasis requested review from a team as code owners September 21, 2026 22:47
@sourcery-ai

sourcery-ai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This documentation-only change fixes two docstring typos and corrects the project URL in package metadata; runtime behavior is unchanged.

File-Level Changes

Change Details Files
Corrected verb agreement in two function docstrings to match the surrounding documentation style.
  • Changed “unmount” to “unmounts” in the umount_be docstring.
  • Changed “check” to “checks” in the is_file_system_zfs docstring.
bectl.py
Fixed the package project URL in the setup metadata.
  • Added the missing .com domain component to the GitHub URL.
setup.py

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!

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@ericbsd ericbsd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ericbsd
ericbsd merged commit 2fe6658 into ghostbsd:master Sep 22, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in Development Tracker Sep 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants