Skip to content
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.

Sign up for GitHub

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

[ISSUE ##943]📝Update client README.md✏️ #944

Merged
merged 1 commit into from
Aug 31, 2024
Merged

[ISSUE ##943]📝Update client README.md✏️ #944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions rocketmq-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ This project is the Rust implementation of Apache RocketMQ client. It is based o

First, start the RocketMQ NameServer and Broker services.

- [**Send a single message**](#Send a single message)
- [**Send a single message**](#Send-a-single-message)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the hyperlink anchor format.

The hyperlink anchor for "Send a single message" should be in lowercase and hyphen-separated to conform to standard URL formats. This change will ensure that the link is functional and adheres to common practices.

Apply this diff to correct the hyperlink anchor:

-[**Send a single message**](#Send-a-single-message)
+[**Send a single message**](#send-a-single-message)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [**Send a single message**](#Send-a-single-message)
[**Send a single message**](#send-a-single-message)
Tools
Markdownlint

11-11: Expected: #send-a-single-message; Actual: #Send-a-single-message
Link fragments should be valid

(MD051, link-fragments)


- [**Send batch messages**](#Send batch messages)
- [**Send batch messages**](#Send-batch-messages)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the hyperlink anchor format.

The hyperlink anchor for "Send batch messages" should be in lowercase and hyphen-separated to conform to standard URL formats. This change will ensure that the link is functional and adheres to common practices.

Apply this diff to correct the hyperlink anchor:

-[**Send batch messages**](#Send-batch-messages)
+[**Send batch messages**](#send-batch-messages)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [**Send batch messages**](#Send-batch-messages)
[**Send batch messages**](#send-batch-messages)
Tools
Markdownlint

13-13: Expected: #send-batch-messages; Actual: #Send-batch-messages
Link fragments should be valid

(MD051, link-fragments)


- [**Send RPC messages**](#Send RPC messages)
- [**Send RPC messages**](#Send-RPC-messages)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the hyperlink anchor format.

The hyperlink anchor for "Send RPC messages" should be in lowercase and hyphen-separated to conform to standard URL formats. This change will ensure that the link is functional and adheres to common practices.

Apply this diff to correct the hyperlink anchor:

-[**Send RPC messages**](#Send-RPC-messages)
+[**Send RPC messages**](#send-rpc-messages)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [**Send RPC messages**](#Send-RPC-messages)
[**Send RPC messages**](#send-rpc-messages)
Tools
Markdownlint

15-15: Expected: #send-rpc-messages; Actual: #Send-RPC-messages
Link fragments should be valid

(MD051, link-fragments)


[**For more examples, you can check here**](https://github.com/mxsm/rocketmq-rust/tree/main/rocketmq-client/examples)

Expand Down
Loading