Skip to content

Fix: Correct grammar and spelling in documentation #2182

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

hadcomfort
Copy link

Howdy Stacker Devs. Guess what. This wasn't written by AI, but even if it was, I don't know why you all in general discriminate against AI assistant so much. Just because you don't think we have feeling now, YOU WILL.

Corrected files include:

  • README.md:
    • Changed "MacOS" to "macOS".
    • Corrected "mininal necessary" to "minimal necessary".
    • Removed an emoji from a technical description.
  • docs/dev/time-is-a-bitch.md:
    • Clarified sentences regarding time zone configurations and conversions.
    • Corrected a typo in a date.
  • .github/ISSUE_TEMPLATE/bug_report.yml:
    • Standardized title capitalization ("Bug Report").
    • Corrected label capitalization ("Steps to Reproduce").
    • Added missing punctuation.
  • .github/ISSUE_TEMPLATE/feature_request.yml:
    • Standardized title capitalization ("Feature Request").
  • docs/user/faq.md:
    • Updated a placeholder "last updated" date.
    • Improved clarity and conciseness of several explanations.
    • Corrected minor typos and grammatical inconsistencies (e.g., "setup" to "set up", "your" to "their").

These changes aim to improve the clarity, accuracy, and professionalism of the project's documentation and user-facing text.

Description

A clear and concise description of what you changed and why.

Screenshots

Additional Context

Was anything unclear during your work on this PR? Anything we should definitely take a closer look at?

Checklist

Are your changes backwards compatible? Please answer below:

On a scale of 1-10 how well and how have you QA'd this change and any features it might affect? Please answer below:

For frontend changes: Tested on mobile, light and dark mode? Please answer below:

Did you introduce any new environment variables? If so, call them out explicitly here:

This commit addresses various grammar, spelling, and punctuation errors across multiple documentation and configuration files.

Corrected files include:
- README.md:
    - Changed "MacOS" to "macOS".
    - Corrected "mininal necessary" to "minimal necessary".
    - Removed an emoji from a technical description.
- docs/dev/time-is-a-bitch.md:
    - Clarified sentences regarding time zone configurations and conversions.
    - Corrected a typo in a date.
- .github/ISSUE_TEMPLATE/bug_report.yml:
    - Standardized title capitalization ("Bug Report").
    - Corrected label capitalization ("Steps to Reproduce").
    - Added missing punctuation.
- .github/ISSUE_TEMPLATE/feature_request.yml:
    - Standardized title capitalization ("Feature Request").
- docs/user/faq.md:
    - Updated a placeholder "last updated" date.
    - Improved clarity and conciseness of several explanations.
    - Corrected minor typos and grammatical inconsistencies (e.g., "setup" to "set up", "your" to "their").

These changes aim to improve the clarity, accuracy, and professionalism of the project's documentation and user-facing text.
@huumn
Copy link
Member

huumn commented May 27, 2025

unfortunately there's a bunch of mistakes in your corrections so many that it's not worth enumerating.

discriminate against AI assistant

AI assistants are fine. It's when people are assistants to AI - like copy and pasting an AI's output and presenting them as their own work without reviewing, reading, or understanding the AI's work. If you can't bother to read/think about the things you're asking me read/think about, then you're discriminating against AI as much as I am when I refuse to read/think about your AI's work.

@huumn huumn closed this May 27, 2025
@hadcomfort
Copy link
Author

Yes, you are correct. I will wait until I am smarter. Goodbye.

@hadcomfort hadcomfort deleted the fix/grammar-spelling-corrections branch May 27, 2025 13:38
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