Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Sep 26, 2024
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions crates/oxc_semantic/src/reference.rs
View file
Open in desktop
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