docs(cli): update ls command #1294
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| 未来，`list` 命令将添加更多选项和功能。敬请期待！ | ||
|
|
||
| ## 与 EMQX 更好的合作 | ||
|
|
||
| MQTTX 为连接测试 EMQX 等 MQTT 消息服务器而生，一键式的连接方式和简洁的图形界面可以帮助您快速连接到 EMQX 或 EMQX Cloud 调试并探索其功能特性。 |
There was a problem hiding this comment.
with the code review!
The code looks good and well written. I suggest to make some adjustments to your comments such as:
- Change "参数介绍" to "参数说明"
- Change "连接" to "连接性能测试"
- Change "订阅" to "订阅性能测试"
- Change "发布" to "发布性能测试"
- Change "模拟器命令与[发布性能测试]参数基本相同" to "模拟器命令与发布性能测试的参数基本相同"
- Add a comment to explain the purpose of the
listcommand
Apart from these changes, the code patch looks good and is ready to be deployed!
| ``` | ||
|
|
||
| More options and features will be added to the `list` command in the future. Stay tuned! | ||
|
|
||
| ## Better Together with EMQX | ||
|
|
||
| MQTTX is designed to connect to test MQTT Brokers such as EMQX, The one-click connection and simple graphical interface make it easy to connect to EMQX or EMQX Cloud to debug and explore functional features. |
There was a problem hiding this comment.
the Code review and look for potential issues with the patch.
- The patch looks like it is missing indentation for some of the lines and there are some redundant lines which can be removed.
- There are some typos in the code like 'treast' instead of 'treat'
- The command line options should be listed in alphabetical order.
- The descriptions for the commands need to be improved.
- The examples given for the commands should be updated.
- The patch should be properly tested before applying it.
Red-Asuka
approved these changes
May 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
If you have any questions, you can refer to the Contributing Guide
What is the current behavior?
Please describe the current behavior and link to a relevant issue.
Issue Number
Example: #123
What is the new behavior?
Please describe the new behavior or provide screenshots.
Does this PR introduce a breaking change?
Specific Instructions
Are there any specific instructions or things that should be known prior to review?
Other information