-
Notifications
You must be signed in to change notification settings - Fork 133
docs: Provide CN translation for kconfigeditor.rst #1374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
WalkthroughAdded and edited documentation for a new KConfig Editor: refined English doc styling and punctuation in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/en/additionalfeatures/kconfigeditor.rst(5 hunks)docs/zh_CN/additionalfeatures.rst(1 hunks)docs/zh_CN/additionalfeatures/kconfigeditor.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build_macos
- GitHub Check: build_linux
- GitHub Check: build_windows
🔇 Additional comments (2)
docs/en/additionalfeatures/kconfigeditor.rst (2)
4-5: Translation link addition looks correct.
40-48: Thekconfiglexer is a valid, standard Pygments lexer and will not cause build warnings.The
kconfiglexer is officially supported by Pygments and is the correct choice for Sphinx documentation. The code-block directives at lines 51 and 119 indocs/en/additionalfeatures/kconfigeditor.rstare correct and will render without warnings in the esp_docs build system used by this project.
|
Hi @Shen7436, the translation LGTM! |
0cici
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Shen7436 , overall LGTM! Pls check my suggestions. Thx!
c0061f2 to
f28623c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/zh_CN/additionalfeatures/kconfigeditor.rst (1)
40-60: Add clarification on alternative IDF_TARGET syntax forms.The auto-pairing example (line 56) uses the string-comparison form (
IDF_TARGET="esp32") while the later code example (line 124) uses the boolean-symbol form (IDF_TARGET_ESP32). Both forms are valid in ESP-IDF Kconfig, but the inconsistency may confuse readers unfamiliar with both idioms.Consider adding a one-line clarification after the example at line 60, noting that both syntactic forms are supported and equivalent (e.g., "注:
IDF_TARGET="esp32"和IDF_TARGET_ESP32是两种等价的方式,均在 ESP-IDF Kconfig 中支持。").Apply this diff to add a clarification note:
当输入 ``depends on (`` 时,编辑器会自动补上 ``)``,并将光标置于二者之间。 + +.. note:: + + ``IDF_TARGET="esp32"`` 和 ``IDF_TARGET_ESP32`` 是两种等价的方式,均在 ESP-IDF Kconfig 中支持。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
docs/en/additionalfeatures/kconfigeditor.rst(5 hunks)docs/zh_CN/additionalfeatures.rst(1 hunks)docs/zh_CN/additionalfeatures/kconfigeditor.rst(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/en/additionalfeatures/kconfigeditor.rst
- docs/zh_CN/additionalfeatures.rst
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build_windows
- GitHub Check: build_linux
- GitHub Check: build_macos
🔇 Additional comments (2)
docs/zh_CN/additionalfeatures/kconfigeditor.rst (2)
140-145: References are appropriate and well-formatted.The three reference links provide comprehensive coverage of KConfig language documentation, Linux Kconfig reference, and Eclipse TM4E. All links appear current and relevant for readers seeking deeper understanding.
1-15: No casing inconsistency exists. The toctree entry indocs/zh_CN/additionalfeatures.rstdisplays "KConfig 编辑器" (with capital K), which matches the file title exactly. The lowercase filename pathkconfigeditorin the reference is correct and unrelated to the display text casing.Likely an incorrect or invalid review comment.
This PR:
kconfigeditor.rstSummary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.