Include README.md as doc in lib.rs #121
Closed
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
uklotzde
reviewed
Jul 13, 2022
|
|
||
| [](https://crates.io/crates/tokio-modbus) | ||
| [](https://docs.rs/tokio-modbus/) | ||
| [](https://github.com/slowtec/tokio-modbus/actions/workflows/security-audit.yaml) | ||
| [](https://github.com/slowtec/tokio-modbus/actions/workflows/continuous-integration.yaml) | ||
|
|
||
| Modbus is based on a [master/slave](https://en.wikipedia.org/wiki/Master/slave_(technology)) | ||
| model. | ||
| To avoid confusions with the tokio terminology the master is called *client* |
There was a problem hiding this comment.
'confusion' without plural 's'? Also 'Tokio' capitalized as name.
|
|
||
| [](https://crates.io/crates/tokio-modbus) | ||
| [](https://docs.rs/tokio-modbus/) | ||
| [](https://github.com/slowtec/tokio-modbus/actions/workflows/security-audit.yaml) | ||
| [](https://github.com/slowtec/tokio-modbus/actions/workflows/continuous-integration.yaml) | ||
|
|
||
| Modbus is based on a [master/slave](https://en.wikipedia.org/wiki/Master/slave_(technology)) | ||
| model. |
There was a problem hiding this comment.
'model' or more specific 'topology' in this context?
|
I also used this for new crates to avoid redundant docs and to ensure visibility on all platforms (docs.rs/crates.io/github.com). |
|
Merged. |
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.
No description provided.