docs(pubsub): handler examples#4639
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4639 +/- ##
=======================================
Coverage 95.02% 95.02%
=======================================
Files 195 195
Lines 7473 7473
=======================================
Hits 7101 7101
Misses 372 372 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
coryan
left a comment
There was a problem hiding this comment.
Better than before, but find out if the use of backticks in a cross-reference is common.
|
|
||
| //! Handlers for acknowledging or rejecting messages. | ||
| //! | ||
| //! To acknowledge (ack) a message, you call [`Handler::ack()`]. |
There was a problem hiding this comment.
I think you are going to prove me wrong, but I expect we use [Handler::ack()] (without backticks inside the brackets) more often.
There was a problem hiding this comment.
Regardless, I think code should look like code.
But yes, I do think we omit the backticks more often than not. e.g. when linking builders back to the client methods.
There was a problem hiding this comment.
https://doc.rust-lang.org/rustdoc/write-documentation/linking-to-items-by-name.html
Most of the examples in here stylize code links with the backticks
Part of the work for #4508
I am too lazy to play the doc pdf game. Here is a screenshot that googlers can see: https://screenshot.googleplex.com/7tNufCHHTjudwDy