docs(ast): fix comment for ClassElement::r#static (#6771)

Follow-up after #6731. Make a long comment to remove ambiguity about what this method does for once and for all!
This commit is contained in:
overlookmotel 2024-10-22 10:38:15 +00:00
parent e15b7ce09c
commit 91651e0a3b

View file

@ -1344,8 +1344,22 @@ impl<'a> ClassElement<'a> {
matches!(self, Self::StaticBlock(_))
}
/// Returns `true` if this [`ClassElement`] is a property and has a
/// static modifier.
/// Returns `true` if this [`ClassElement`] has a static modifier.
///
/// Note: Class static blocks do not have a "modifier", as there is no non-static equivalent.
/// Therefore, returns `false` for static blocks.
///
/// The following all return `true`:
/// ```ts
/// class {
/// static prop = 1;
/// static method() {}
/// static #private = 2;
/// static #privateMethod() {}
/// static accessor accessorProp = 3;
/// static accessor #privateAccessorProp = 4;
/// }
/// ```
pub fn r#static(&self) -> bool {
match self {
Self::TSIndexSignature(_) | Self::StaticBlock(_) => false,