chore: add typos ci, fix typos in readme - #523
Merged
Merged
Conversation
Signed-off-by: Keming <kemingy94@gmail.com>
There was a problem hiding this comment.
🟢 Approval recommended
Changes are low-risk documentation/CI updates, and the remaining feedback is limited to minor doc wording improvements.
Pull request overview
This PR tightens documentation wording in the README and adds a typos check to the documentation CI workflow so documentation-related changes are automatically spellchecked during CI.
Changes:
- Fixes a couple of typos/wording issues in
README.md. - Runs
crate-ci/typosas part of thepythondocworkflow and expands the workflow path filters to includeREADME.md. - Updates the CodeQL action bundle pin and bumps
actions/deploy-pagespatch version.
File summaries
| File | Description |
|---|---|
| README.md | Corrects wording/typos in documentation sections. |
| .github/workflows/pythondoc.yml | Adds typos check step and triggers on README.md; updates Pages deploy action pin. |
| .github/workflows/codeql.yml | Updates pinned CodeQL action bundle version. |
Review details
Suppressed comments (1)
README.md:219
- This sentence has a couple of grammatical issues ("corresponds to define" and missing articles). Rephrasing improves readability in the docs.
1. You can enforce security on individual API endpoints by defining the `security` argument in the `spec.validate` decorator of relevant function/method (this corresponds to define security section on operation level, under `paths`, in `OpenAPI`). `security` argument is defined as a dictionary, where each key is the name of security used in `security_schemes` argument of `SpecTree` constructor and its value is required security scope, as is shown in the following example:
- Files reviewed: 3/3 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
188
to
+190
| Before v1.3.0, this only skip the response validation. | ||
|
|
||
| Starts from v1.3.0, this will skip all the validations. As an result, you won't be able to access the validated data from `context`. | ||
| Starts from v1.3.0, this will skip all the validations. As a result, you won't be able to access the validated data from `context`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.