Skip to content

vn.py guide is the only Chinese doc in docs/integrations/, and skips the .zh-CN convention #130

Description

@FlyM1ss

Follow-up from the #118 review. Fine if deliberate — flagging the inconsistency, not the language.

docs/integrations/vnpy-simulation.md is Chinese; every sibling is English:

doc CJK lines
finsearch-news-items.md 0/128
finsearch-news-sentiment.md 1/211
vnpy-simulation.md 31/80

It is signposted — docs/README.md:33 labels it "(Chinese)" — so this isn't an oversight.

The sharper point: #118 established a bilingual convention in the same PR, and the guide is the one file that doesn't follow it.

  • spec → ...-design.md (English) + ...-design.zh-CN.md (Chinese sibling)
  • guide → plain .md, Chinese content, no English sibling

So the .zh-CN suffix already means "Chinese translation of the file next to it" in this repo, and a reader who learned that from the spec will guess wrong about the guide.

Cheapest fix that matches the convention already here: rename to vnpy-simulation.zh-CN.md and add an English vnpy-simulation.md, even a short one. Renaming alone (no English sibling) is worse — it'd imply a translation target that doesn't exist.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions