Skip to content

Commit

Permalink
docs(semantic): improve doc comments on Reference methods (#6076)
Browse files Browse the repository at this point in the history
  • Loading branch information
overlookmotel committed Sep 26, 2024
1 parent c2616f7 commit efabfc8
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions crates/oxc_semantic/src/reference.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,17 @@ impl Reference {
&mut self.flags
}

/// Returns `true` if the identifier value was read. This is not mutually
/// exclusive with [`#is_write`]
/// Returns `true` if the identifier value was read.
///
/// This is not mutually exclusive with [`Reference::is_write`].
#[inline]
pub fn is_read(&self) -> bool {
self.flags.is_read()
}

/// Returns `true` if the identifier was written to. This is not mutually
/// exclusive with [`#is_read`]
/// Returns `true` if the identifier was written to.
///
/// This is not mutually exclusive with [`Reference::is_read`].
#[inline]
pub fn is_write(&self) -> bool {
self.flags.is_write()
Expand Down

0 comments on commit efabfc8

Please sign in to comment.