fix: typos in documentation#1739
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @cmw-creator! It looks like this is your first PR to kmesh-net/kmesh 🎉 |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a minor typo in the project's documentation files. It updates the incorrect flag name '--profiliing' to the correct '--profiling' to ensure consistency and accuracy for users referencing the command-line interface documentation. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. A typo hidden in the text, / Was causing users to be vexed. / One letter changed to make it right, / Now documentation shines so bright. Footnotes
|
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Fixes a typo in the kmesh-daemon flags documentation so the profiling flag is correctly spelled and consistently listed.
Changes:
- Corrects
--profiliingto--profilingin English docs. - Corrects
--profiliingto--profilingin Chinese docs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/en/kmesh_commands.md | Fixes the profiling flag name in the Flags section. |
| docs/cn/zh/kmesh_commands-zh.md | Mirrors the profiling flag name fix in the localized commands doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --mode string controller plane mode, valid values are [kernel-native, dual-engine] (default "dual-engine") | ||
| --monitoring string enable kmesh traffic monitoring in daemon process(default "true") | ||
| --profiliing string whether to enable profiling or not (default "false") | ||
| --profiling string whether to enable profiling or not (default "false") |
| --mode string controller plane mode, valid values are [kernel-native, dual-engine] (default "dual-engine") | ||
| --monitoring string enable kmesh traffic monitoring in daemon process(default "true") | ||
| --profiliing string whether to enable profiling or not (default "false") | ||
| --profiling string whether to enable profiling or not (default "false") |
There was a problem hiding this comment.
Code Review
This pull request corrects a typo in the documentation files docs/cn/zh/kmesh_commands-zh.md and docs/en/kmesh_commands.md, changing --profiliing to --profiling. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Fixes:
--profiliing→--profilingin docs/en/kmesh_commands.md--profiliing→--profilingin docs/cn/zh/kmesh_commands-zh.mdCloses #1736