Skip to content

docs: fix two typos in pkgx documentation - #1298

Merged
jhheider merged 1 commit into
pkgxdev:mainfrom
Jah-yee:fix/docs-typos-supresses-soemthing
Oct 31, 2026
Merged

jhheider merged 1 commit into
pkgxdev:mainfrom
Jah-yee:fix/docs-typos-supresses-soemthing

Conversation

@Jah-yee

@Jah-yee Jah-yee commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • What changed: Fixed two spelling mistakes in the user-facing documentation.
    • docs/pkgx.md:143 — supresses resolving/syncing etc. messages → suppresses ... (in the --quiet output example).
    • docs/scripting.md:151 — which git # prints soemthing like ... → prints something like ....
  • Why: Both words are misspelled in text users read while learning the CLI. supresses appears in the explanatory comment for --quiet, and soemthing in the shell-script example under "Writing scripts with pkgx". These are pure documentation typos — no code, flags, or runtime behavior touched.

AI Intent

  • Prompt or task statement: Scan the repository for spelling mistakes in documentation and open a minimal PR that fixes them.
  • Scope of AI-assisted changes: Two single-word spelling corrections in docs/. No code was generated or modified, and no logic was written or reviewed by AI.

Risk Assessment

  • Risk level: low
  • Primary risks: None functionally; a typo fix could theoretically alter copy someone depends on, but both strings are inline shell comments in documentation blocks, not parsed by the CLI.
  • Compatibility impact: None. No Rust source, CLI flags, or output strings were changed.

Rollback Plan

  • Revert path: git revert 7ffece5 reverts the single commit and restores both comments.
  • Forward-fix path (if revert is not possible): Re-apply the inverse string substitutions in docs/pkgx.md and docs/scripting.md.

Validation

  • Local checks run: git diff --stat confirms 2 files changed, 2 insertions(+), 2 deletions(-). Verified the surrounding code fences and shell examples still parse as before (the edited lines are comments inside fenced blocks). markdownlint config in .github/markdownlint.yml was checked; the changed lines stay within the MD013 line-length limit.
  • CI checks expected: Documentation-only change, so cargo fmt / cargo clippy / cargo test are unaffected. The markdown lint workflow should pass since no structural markdown was modified.

Internal/Public Boundary Check

  • No internal-only data, private URLs, secrets, or private runbooks were added.

- docs/pkgx.md: 'supresses' -> 'suppresses' in the --quiet output example
- docs/scripting.md: 'soemthing' -> 'something' in the which git example

Both are spelling mistakes in user-facing docs; no behavior change.
@jhheider
jhheider merged commit ce31979 into pkgxdev:main Oct 31, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants