Weekly keywords check: mismatches found
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.8k
- Forks
- 1.2k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 31
Description
Weekly Keywords Check Report
Summary
- master — Keywords check result: ❌ mismatch
- release-8.5 — Keywords check result: ❌ mismatch
master — 2 issue(s)
Comparing keywords.md
against TiDB parser (master):
Missing docs for non-reserved keyword from UnReservedKeyword: OLD
Missing docs for non-reserved keyword from UnReservedKeyword: RETAIN
release-8.5 — 7 issue(s)
Comparing keywords.md
against TiDB parser (release-8.5):
Missing docs for reserved keyword: LATERAL
Missing docs for non-reserved keyword from UnReservedKeyword: RULE
Missing docs for non-reserved keyword from UnReservedKeyword: TIMEOUT
Missing docs for non-reserved keyword from UnReservedKeyword: VECTOR
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTE
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTION
Missing docs for non-reserved keyword from TiDBKeyword: DISTRIBUTIONS
How to fix
Update keywords.md on the affected branch to match the current TiDB parser keywords.
See check-keywords.py for details.
Run date: 2026-06-24 05:28 UTC
Workflow run: https://github.com/pingcap/docs-cn/actions/runs/28077320085
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with keywords.md on the master and release-8.5 branches, then read scripts/check-keywords.py to understand how the report compares documentation with the TiDB parser. Add documentation for the listed missing keywords on each affected branch, and rerun the keyword check until both branch reports show no mismatches.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100