From 8a5187501e02788b4401f333bce33f85d65789cd Mon Sep 17 00:00:00 2001 From: EricLBuehler Date: Wed, 12 Jul 2023 05:15:18 -0400 Subject: [PATCH] Update readme to match docs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aacde19..d167ca7 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,8 @@ A `Weak` is a non-owning reference to the data held by a `Trc`. They break reference cycles by adding a layer of indirection and act as an observer. They cannot even access the data directly, and must be converted back into `Trc`. `Weak` does not keep the value alive (which can be dropped), and only keeps the backing allocation alive. -To soundly implement thread safety `Trc` does not implement `Send` or `Sync`. However, `SharedTrc` does, and it is the only way to safely send a `Trc` across threads. See `SharedTrc` for it's API, which is similar to that of `Weak`. +To soundly implement thread safety `Trc` does not itself implement [`Send`] or [`Sync`]. However, `SharedTrc` does, and it is the only way to +safely send a `Trc` across threads. See [`SharedTrc`] for it's API, which is similar to that of `Weak`. ## Examples