Skip to content

fix(docs): improve grammar and readability in readme#38

Merged
vinayak25 merged 1 commit intointentjs:mainfrom
muath-ye:main
Dec 4, 2024
Merged

fix(docs): improve grammar and readability in readme#38
vinayak25 merged 1 commit intointentjs:mainfrom
muath-ye:main

Conversation

@muath-ye
Copy link
Contributor

@muath-ye muath-ye commented Dec 4, 2024

This pull request improves the grammar, clarity, and overall readability of the Intent framework README. Here’s a list of the important changes:

  1. Redundant conjunction:

    • Original: "While NestJS provides great syntax and structure to your application, but it lacks..."
    • Fixed: Removed "but" because "while" already contrasts the clauses.
  2. Consistency in compound nouns:

    • Original: "real world scenario"
    • Fixed: Added a hyphen to make it "real-world scenario."
  3. Clarity in enumeration:

    • Original: "...web views and what not."
    • Fixed: Changed to "web views, and whatnot," improving punctuation and consolidating "what not" into "whatnot" (a single word).
  4. Parallelism in lists:

    • Original: "...features like database integration, queue integration, event listeners, task scheduling etc."
    • Fixed: Added a comma before "etc." to follow standard punctuation rules.

These updates ensure the text is grammatically correct and easier to read while retaining the original meaning and intent.

- Removed redundant conjunction in sentence about NestJS syntax and structure
- Added hyphen to "real-world scenario" for grammatical correctness
- Changed "which are" to "that are" for restrictive clause clarity
- Consolidated "what not" into "whatnot" for proper word usage
- Replaced repetitive "providing" with "offering" for improved readability
- Added missing comma before "etc." in feature list
@vinayak25 vinayak25 merged commit 7380542 into intentjs:main Dec 4, 2024
@vinayak25
Copy link
Member

Thanks for this! @muath-ye

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