docs(semantic): improve doc comments on Reference methods (#6076)

This commit is contained in:
overlookmotel 2024-09-26 12:22:31 +00:00
parent c2616f7fa1
commit efabfc8dac

View file

@ -95,15 +95,17 @@ impl Reference {
&mut self.flags &mut self.flags
} }
/// Returns `true` if the identifier value was read. This is not mutually /// Returns `true` if the identifier value was read.
/// exclusive with [`#is_write`] ///
/// This is not mutually exclusive with [`Reference::is_write`].
#[inline] #[inline]
pub fn is_read(&self) -> bool { pub fn is_read(&self) -> bool {
self.flags.is_read() self.flags.is_read()
} }
/// Returns `true` if the identifier was written to. This is not mutually /// Returns `true` if the identifier was written to.
/// exclusive with [`#is_read`] ///
/// This is not mutually exclusive with [`Reference::is_read`].
#[inline] #[inline]
pub fn is_write(&self) -> bool { pub fn is_write(&self) -> bool {
self.flags.is_write() self.flags.is_write()