-
Notifications
You must be signed in to change notification settings - Fork 0
Fix dead citation refs #142
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -154,14 +154,14 @@ network protocols, offering insights into effective abstractions. | |||||||||||||
| Although designed for RPC, its approach of defining service schemas directly | ||||||||||||||
| in Rust code (using the `#[tarpc::service]` attribute to generate service | ||||||||||||||
| traits and client/server boilerplate) is an interesting parallel to | ||||||||||||||
| "wireframe's" goal of reducing boilerplate for message handlers.20 Features | ||||||||||||||
| like pluggable transports and serde serialization further highlight its modern | ||||||||||||||
| "wireframe's" goal of reducing boilerplate for message handlers. Features like | ||||||||||||||
| pluggable transports and serde serialization further highlight its modern | ||||||||||||||
| design. | ||||||||||||||
|
Comment on lines
+157
to
159
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Use British spelling and crate-proper capitalisation
- pluggable transports and serde serialization further highlight its modern
+ pluggable transports and Serde serialisation further highlight its modern📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
|
|
||||||||||||||
| A clear pattern emerges from these libraries: the use of derive macros and | ||||||||||||||
| trait-based designs is a prevalent and effective strategy in Rust for | ||||||||||||||
| simplifying protocol handling and reducing boilerplate code. Both `bin-proto` 14 | ||||||||||||||
| and `protocol` 16 leverage custom derives to generate (de)serialization logic | ||||||||||||||
| simplifying protocol handling and reducing boilerplate code. Both `bin-proto` | ||||||||||||||
| and `protocol` leverage custom derives to generate (de)serialization logic | ||||||||||||||
|
Comment on lines
+163
to
+164
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧹 Nitpick (assertive) Consistent en-GB spelling for “serialisation” The same spelling issue appears here (and the capital “S” is not needed inside the back-ticks). - simplifying protocol handling and reducing boilerplate code. Both `bin-proto`
- and `protocol` leverage custom derives to generate (de)serialization logic
+ simplifying protocol handling and reducing boilerplate code. Both `bin-proto`
+ and `protocol` leverage custom derives to generate (de)serialisation logic📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
| directly from struct and enum definitions. This is a proven pattern for | ||||||||||||||
| enhancing developer ergonomics and reducing the likelihood of manual | ||||||||||||||
| implementation errors. "wireframe" should strongly consider adopting a similar | ||||||||||||||
|
|
@@ -1348,7 +1348,7 @@ simplicity; "wireframe" aims for similar illustrative power with its examples. | |||||||||||||
|
|
||||||||||||||
| A primary motivation for "wireframe" is to reduce the inherent source code | ||||||||||||||
| complexity often encountered when developing systems that communicate over | ||||||||||||||
| custom binary protocols. The inaccessibility of the `leynos/mxd` repository 7 | ||||||||||||||
| custom binary protocols. The inaccessibility of the `leynos/mxd` repository | ||||||||||||||
| prevents a direct before-and-after comparison, but we can identify common | ||||||||||||||
| sources of complexity in such projects and articulate how "wireframe's" design | ||||||||||||||
| choices aim to mitigate them. | ||||||||||||||
|
|
||||||||||||||
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.
🧹 Nitpick (assertive)
Paragraph wraps exceed the documented 80-column limit
The edited sentence now reads well, but the whole paragraph is > 80 characters wide, which violates the docs style guide in
coding_guidelines.Please run
mdformat-all/markdownlintwith the relevant wrap settings or re-flow the lines manually.🤖 Prompt for AI Agents