LibWeb: Convert Ladybird notes in spec steps to // NB: ...

We have a couple of ways to designate spec notes and (our) developer
notes in comments, but we never really settled on a single approach. As
a result, we have a bit of a mixed bag of note comments on our hands.

To the extent that I could find them, I changed developer notes to
`// NB: ...` and changed spec notes to `// NOTE: ...`. The rationale for
this is that in most web specs, notes are prefixed by `NOTE: ...` so
this makes it easier to copy paste verbatim. The choice for `NB: ...` is
pretty arbitrary, but it makes it stand out from the regular spec notes
and it was already in wide use in our codebase.
This commit is contained in:
Jelle Raaijmakers 2025-11-17 13:10:41 +01:00 committed by Tim Flynn
parent 9394c9a10b
commit 41eb7251e4
Notes: github-actions[bot] 2025-11-18 14:09:02 +00:00
11 changed files with 52 additions and 44 deletions

View file

@ -258,7 +258,8 @@ WebIDL::ExceptionOr<void> FileReader::read_operation(Blob& blob, Type type, Opti
if (m_state != State::Loading)
dispatch_event(DOM::Event::create(realm, HTML::EventNames::loadend));
// Spec-Note: Event handler for the load or error events could have started another load, if that happens the loadend event for this load is not fired.
// NOTE: Event handler for the load or error events could have started another load, if that happens
// the loadend event for this load is not fired.
}));
return;
@ -278,7 +279,8 @@ WebIDL::ExceptionOr<void> FileReader::read_operation(Blob& blob, Type type, Opti
if (m_state != State::Loading)
dispatch_event(DOM::Event::create(realm, HTML::EventNames::loadend));
// Spec-Note: Event handler for the error event could have started another load, if that happens the loadend event for this load is not fired.
// NOTE: Event handler for the error event could have started another load, if that happens the
// loadend event for this load is not fired.
}));
return;