aboutsummaryrefslogtreecommitdiff
path: root/azalea/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'azalea/README.md')
-rw-r--r--azalea/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/azalea/README.md b/azalea/README.md
index 5d0b6d5f..7860741a 100644
--- a/azalea/README.md
+++ b/azalea/README.md
@@ -57,9 +57,11 @@ async fn main() {
#[derive(Default, Clone, Component)]
pub struct State {
/// An example field that stores the number of messages that've been
- /// received by the client so far. The state gets cloned whenever the
- /// handler is called, so to have all the clones point to the same data and
- /// have it be mutable, we use an Arc<Mutex<T>>.
+ /// received by the client so far.
+ ///
+ /// The state gets cloned whenever the handler is called, so to have all
+ /// the clones point to the same data and have it be mutable, we use an
+ /// Arc<Mutex<T>>.
pub messages_received: Arc<Mutex<usize>>
}