Skip to content

docs: fix grammar and typos across install_station modules - #17

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

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

Conversation

@Avicennasis

@Avicennasis Avicennasis commented Sep 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Fix subject-verb agreement ("contain" -> "contains") and typo issues across 5 files:

  • install_station/common.py: "password contain" -> "password contains" (docstrings and :return: lines across all password-check functions); "and some special character." -> "...characters."
  • install_station/install_type.py: "for select what type" -> "for selecting what type"
  • install_station/data.py: "commonly use variables" -> "commonly used variables"
  • install_station/install.py: "Those for next 4 line is for debugging only." -> "These next 4 lines are for debugging only."
  • setup.py: malformed URL https://github/... -> https://github.com/...

No functional changes — comments, docstrings, and a package metadata URL only.

Summary by Sourcery

Improve project text quality and correct the package metadata URL without changing runtime behavior.

Enhancements:

  • Correct grammar and typos throughout install_station documentation, comments, and docstrings.

Build:

  • Correct the project homepage URL in package metadata.

@Avicennasis
Avicennasis requested review from a team as code owners September 20, 2026 17:42
@sourcery-ai

sourcery-ai Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

This documentation-only cleanup fixes grammar, typos, and comment wording across the install_station modules, plus corrects the package metadata homepage URL; no executable behavior or password-validation logic changes.

File-Level Changes

Change Details Files
Corrected grammar and wording in password-validation documentation and comments without changing validation logic.
  • Updated subject-verb agreement across password-check function docstrings, return descriptions, and comments.
  • Corrected singular “character” to plural “characters” where appropriate.
install_station/common.py
Fixed grammar and typo issues in module and debugging comments.
  • Changed “use” to “used” in the data module description.
  • Improved the installation-type description for grammatical correctness.
  • Clarified the comment identifying the next four lines as debugging-only code.
install_station/data.py
install_station/install_type.py
install_station/install.py
Corrected the project homepage URL in package 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 bf05636 into ghostbsd:master Sep 20, 2026
2 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in Development Tracker Sep 20, 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