From 92416253e0fa19a88abef27e15c0621ce41b6903 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Thu, 14 Mar 2024 15:07:16 -0500 Subject: [PATCH] fix typo in signal docs --- packages/signals/src/read.rs | 4 ++-- packages/signals/src/write.rs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/signals/src/read.rs b/packages/signals/src/read.rs index 0a06ec268..8b01d2cd7 100644 --- a/packages/signals/src/read.rs +++ b/packages/signals/src/read.rs @@ -57,14 +57,14 @@ pub trait Readable { .map(Self::Storage::downcast_lifetime_ref) } - /// Try to get a reference to the value without checking the lifetime. + /// Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. /// /// NOTE: This method is completely safe because borrow checking is done at runtime. fn try_read_unchecked( &self, ) -> Result, generational_box::BorrowError>; - /// Tet a reference to the value without checking the lifetime. + /// Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal. /// /// NOTE: This method is completely safe because borrow checking is done at runtime. fn read_unchecked(&self) -> ReadableRef<'static, Self> { diff --git a/packages/signals/src/write.rs b/packages/signals/src/write.rs index 2181da3dc..cd8c91043 100644 --- a/packages/signals/src/write.rs +++ b/packages/signals/src/write.rs @@ -42,14 +42,14 @@ pub trait Writable: Readable { self.try_write_unchecked().map(Self::downcast_lifetime_mut) } - /// Try to get a mutable reference to the value without checking the lifetime. + /// Try to get a mutable reference to the value without checking the lifetime. This will update any subscribers. /// /// NOTE: This method is completely safe because borrow checking is done at runtime. fn try_write_unchecked( &self, ) -> Result, generational_box::BorrowMutError>; - /// Tet a mutable reference to the value without checking the lifetime. + /// Get a mutable reference to the value without checking the lifetime. This will update any subscribers. /// /// NOTE: This method is completely safe because borrow checking is done at runtime. fn write_unchecked(&self) -> WritableRef<'static, Self> {