Skip to content

Clean up typos in docs, comments, and UI copy#6045

Open
PeterDaveHello wants to merge 1 commit intoStirling-Tools:mainfrom
PeterDaveHello:docs-comment-typo-fixes
Open

Clean up typos in docs, comments, and UI copy#6045
PeterDaveHello wants to merge 1 commit intoStirling-Tools:mainfrom
PeterDaveHello:docs-comment-typo-fixes

Conversation

@PeterDaveHello
Copy link
Copy Markdown
Contributor

@PeterDaveHello PeterDaveHello commented Apr 1, 2026

Description of Changes

Fix wording, numbering, path references, and minor grammar issues across project guides, backend comments, and frontend strings.

This keeps documentation and user-facing text consistent without changing application behavior.


Checklist

General

Documentation

Translations (if applicable)

UI Changes (if applicable)

  • Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR)

Testing (if applicable)

  • I have tested my changes locally. Refer to the Testing Guide for more details.

Copilot AI review requested due to automatic review settings April 1, 2026 19:03
@dosubot dosubot bot added the size:M This PR changes 30-99 lines ignoring generated files. label Apr 1, 2026
@stirlingbot stirlingbot bot added Documentation Improvements or additions to documentation Java Pull requests that update Java code Front End Issues or pull requests related to front-end development Test Testing-related issues or pull requests Devtools Development tools labels Apr 1, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR cleans up typos and improves consistency in documentation, comments, and user-facing text across the repo.

Changes:

  • Fixes wording/grammar issues in multiple markdown guides and template docs.
  • Corrects typos in frontend/backend comments and UI error text.
  • Updates a few path/script references in documentation to match current repo structure.

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
testing/cucumber/exampleFiles/example.md Fixes markdown list formatting/typo in example content.
README.md Cleans up Support section bullet formatting and “GitHub” capitalization.
frontend/src/proprietary/constants/staticStripeLinks.ts Fixes a typo in a comment (“PRODUCTION”).
frontend/src/core/tests/test-fixtures/README.md Corrects the documented fixtures directory path.
frontend/src/core/services/googleDrivePickerService.ts Fixes typo in an error message (token handling path).
frontend/README.md Minor grammar fix in environment variable guidance.
docs/type3_fallback_plan.md Updates the referenced PDF download script name in the workflow table.
devGuide/STYLELINT.md Fixes Stylelint command paths/config reference in docs.
devGuide/DeveloperGuide.md Minor wording/grammar fixes in build notes.
DeveloperGuide.md Fixes numbering and wording/grammar in setup/build notes.
app/proprietary/src/main/resources/templates/AUDIT_USAGE.md Grammar fix in audit event description.
app/common/src/main/java/stirling/software/common/configuration/AppConfig.java Comment wording fix (“use case”).
Comments suppressed due to low confidence (1)

frontend/src/core/services/googleDrivePickerService.ts:164

  • When response.access_token is null, reject(...) is called but execution continues, setting this.accessToken to null and then calling resolve(). Add an early return (or structure with else) after the reject to prevent resolving the promise on an error path.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Fix wording, numbering, path references, and minor grammar issues across
project guides, backend comments, and frontend strings.

This keeps documentation and user-facing text consistent without
changing application behavior.
@PeterDaveHello PeterDaveHello force-pushed the docs-comment-typo-fixes branch from 6a3724f to cec446b Compare April 3, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Devtools Development tools Documentation Improvements or additions to documentation Front End Issues or pull requests related to front-end development Java Pull requests that update Java code size:M This PR changes 30-99 lines ignoring generated files. Test Testing-related issues or pull requests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants