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

Jump to bottom

docs: Clearly document the behavior of ee.once(). #6371

Closed
wants to merge 4 commits into from
Closed

docs: Clearly document the behavior of ee.once(). #6371

wants to merge 4 commits into from

Commits on Apr 25, 2016

  1. docs: Clearly document the behavior of ee.once(). 

    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.
    @lance
    lance committed Apr 25, 2016
    Configuration menu
    Copy the full SHA
    28b9da8 View commit details
    Browse the repository at this point in the history

  2. doc: Clarity about timing for once listeners. 

    Based on comments from @cjihrig.
    @lance
    lance committed Apr 25, 2016
    Configuration menu
    Copy the full SHA
    0fa1c90 View commit details
    Browse the repository at this point in the history

  3. doc: Clarify behavior of ee.prependOnceListener. 

    Additional documentation changes required for `ee.prependOnceListener`
as per #5566.
    @lance
    lance committed Apr 25, 2016
    Configuration menu
    Copy the full SHA
    dc1049f View commit details
    Browse the repository at this point in the history

  4. doc: Clarify wording for ee.prependOnceListener. 

    Address comments from @addaleax.

Fixes: #5566
    @lance
    lance committed Apr 25, 2016
    Configuration menu
    Copy the full SHA
    4102e92 View commit details
    Browse the repository at this point in the history