Commit 3b46187
doc: Backport ee.once doc clarifications to 4.x.
Addresses #5566. The `ee.once()` function is currently documented as
invoking the listener, and then removing it when the event is
triggered. However, this is not really the case. The listener is removed
and _then_ invoked. This only matters in a narrow set of use cases, but
when it matters, it matters that the docs are correct.
See the issue (#5566) for a discussion on why the code has not been
modified to match the documentation, but instead the documentation has
been modified to match the code.
Fixes: #5566
Ref: #6371
PR-URL: #7103
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>1 parent 4067cde commit 3b46187Copy full SHA for 3b46187
File tree
Expand file treeCollapse file tree
1 file changed
+3
-4
lines changedOpen diff view settings
Filter options
- doc/api
Expand file treeCollapse file tree
1 file changed
+3
-4
lines changedOpen diff view settings
Collapse file
+3-4Lines changed: 3 additions & 4 deletions
- Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| ||
130 | 130 | |
131 | 131 | |
132 | 132 | |
133 | | - |
| 133 | + |
134 | 134 | |
135 | 135 | |
136 | 136 | |
| ||
338 | 338 | |
339 | 339 | |
340 | 340 | |
341 | | - |
342 | | - |
343 | | - |
| 341 | + |
| 342 | + |
344 | 343 | |
345 | 344 | |
346 | 345 | |
|
0 commit comments