-
Notifications
You must be signed in to change notification settings - Fork 215
docs: fix vale linting errors #586
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Pratik Mahalle <[email protected]>
There was a problem hiding this 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 addresses Vale linting and style issues across the documentation, fixing spelling, grammar, and formatting inconsistencies.
- Corrected spelling and punctuation errors in multiple docs.
- Updated code example in Go supported-frameworks to use
WithContext
andFind
. - Harmonized style guidelines and fixed punctuation in style reference.
Reviewed Changes
Copilot reviewed 18 out of 50 changed files in this pull request and generated no comments.
File | Description |
---|---|
versioned_docs/version-2.0.0/concepts | Fixed typos (e.g., “accelrating” → “accelerating”) |
versioned_docs/version-1.0.0/go/supported-frameworks.md | Replaced PingContext /ExecContext example with WithContext & Find |
STYLE.md | Updated quotations and dash style, unified punctuation |
Comments suppressed due to low confidence (4)
STYLE.md:63
- The guideline refers to en dashes but shows an em dash; use the correct en dash character (–) instead of an em dash (—) to match the description.
Use **en dashes (—)** to indicate numeric ranges. Do **not** mix styles or use hyphens inconsistently.
versioned_docs/version-1.0.0/operation/browser-extension.md:58
- [nitpick] Per sentence-case guidelines, consider using lowercase 'first' ("your first test case") since it's not a proper noun.
**Step-2**: Give a title to your First test case
versioned_docs/version-1.0.0/go/supported-frameworks.md:351
- Consider checking and handling errors from subsequent DB operations (like
Find
) to avoid silent failures.
pSQL_DB = pSQL_DB.WithContext(c.Request.Context())
versioned_docs/version-1.0.0/go/supported-frameworks.md:356
- The variable
x
is declared but not used. Consider renaming it to something descriptive or handling the result/error explicitly.
x := pSQL_DB.Find(&people)
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
Signed-off-by: Pratik Mahalle <[email protected]>
@Achanandhi-M , Can you review this? |
Signed-off-by: Pratik Mahalle <[email protected]>
📝 PR Description
🎯 Summary
Fixes Vale linting errors across Keploy documentation, reducing errors.
This pull request addresses the issues with failing
Vale Doc Linter
andPrettier
pipelines as described in Issue #2696.Vale
across the documentation files.Prettier
pipeline configuration.Type of change