Skip to content

docs: translate Chinese comments and docstrings into English - #34

Closed
humdrum00001010 wants to merge 1 commit into
myhloli:mainfrom
humdrum00001010:comments/maybe-english-would-be-helpful
Closed

humdrum00001010 wants to merge 1 commit into
myhloli:mainfrom
humdrum00001010:comments/maybe-english-would-be-helpful

Conversation

@humdrum00001010

Copy link
Copy Markdown

Chinese-only comments and docstrings make the PDF analysis and document conversion implementation difficult to follow for English-speaking contributors. Translate them into English across Python, Rust, tests, tools, workflow comments, CSS, and ignore-file comments. This is a machine-assisted translation with additional manual wording review of the PDF analysis entry points, EPUB renderer, and workflow comments. Preserve executable production code, identifiers, runtime strings, Chinese fixtures, and localized documentation.

The repository has no CONTRIBUTING.md or PR template. One existing architecture test explicitly required Chinese characters in renderer docstrings; make that guard language-neutral while retaining its requirement for responsibility descriptions. This is the only intentional executable-code change, and it is confined to the test guard.

Validation:

  • Python suite with the CI sparse-table exclusion: 7,296 passed, 852 skipped (Python 3.14, macOS arm64, Python backend, PDFium 5.10.1).
  • cargo test -p docvortex-core --locked: 15 passed; Rust formatting passes.
  • Ruff 0.14.2 lint and formatting checks pass.
  • AST/token comparisons confirm executable production code is unchanged; the ignore patterns are unchanged too.
  • A comment/docstring scan finds no remaining Chinese comments or docstrings in the code files.
  • A real PDF-to-EPUB smoke conversion produces a valid EPUB container and preserves the sample paragraph.

Full cross-platform and Rust-backend validation remains to the upstream CI matrix.

@humdrum00001010

humdrum00001010 commented Oct 4, 2026 •

Copy link
Copy Markdown
Author

It's a PR and also an idea proposal, if you dislike it, close!

@myhloli myhloli closed this Oct 5, 2026
@humdrum00001010
humdrum00001010 deleted the comments/maybe-english-would-be-helpful branch October 5, 2026 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants