pingcap / pingcap/docs

Zero-width space (U+200B) characters found embedded in release-8.5 English content

Open Beginner friendly
#23,792 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

What did you do?

While working on PR #23778 (removing stray zero-width-space MT artifacts from the i18n-ja-release-8.5 Japanese translation branch), I checked whether the same artifact exists in the English release-8.5 branch and found that it does.

What did you expect to see?

No invisible/zero-width characters in the English source content.

What did you see instead?

45 occurrences of U+200B (zero-width space) embedded in prose across 16 files in release-8.5, most commonly as a doubled zero-width space between two words (visually invisible, but present in the raw text), e.g.:

  • literal-values.md: "the literal values​​of TiDB SQL statements" / "For month or day values​​less than 10"
  • statistics.md: "the number of values​​falling in the bucket" / "the number of values​​falling into each bucket"
  • dashboard/dashboard-diagnostics-report.md: "configuration values​​of historical time" / "the sum of all values​​(SUM)" / "P80 values for a single transaction of KV writes​​are"
  • Also present in: develop/dev-guide-join-tables.md, encryption-at-rest.md, constraints.md, information-schema/information-schema-deadlocks.md, information-schema/information-schema-data-lock-waits.md, information-schema/information-schema-tidb-trx.md, dm/dm-binlog-event-filter.md, dm/dm-block-allow-table-lists.md, and several releases/release-*.md files.

These are invisible in rendered output, but they exist in the raw Markdown source and get carried into any downstream text processing (search indexing, translation tooling, diffing, etc.).

Question

Are these zero-width spaces intentional (e.g., inserted by some tool for a specific rendering purpose), or are they unintentional artifacts (e.g., leftover from a word processor, browser copy-paste, or an editing tool) that should be cleaned up? If unintentional, I'm happy to submit a PR removing them.

Which version(s) do you use?

release-8.5 branch (also worth checking whether other release branches / master are affected — not checked yet)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the release-8.5 branch by searching the 16 files named in the issue for U+200B, including literal-values.md, statistics.md, and dashboard/dashboard-diagnostics-report.md. Check whether the characters are intentional with the maintainers, then remove confirmed artifacts and verify the branch has no unintended matches in the affected English content.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.