Bug 1671370 - [marionette] Clarify use of current window global in |element| docstrings r=marionette-reviewers,whimboo
authorMaja Frydrychowicz <mjzffr@gmail.com>
Tue, 27 Oct 2020 16:55:31 +0000
changeset 554748 70e2b6b0b177ceb3c70569bcb0c795ad20723a83
parent 554747 341526d13eb84bcddc76d3e584160e3e9440459a
child 554749 8b5452963b2cb9c754af6b8149439c3ca844199c
push id37898
push userabutkovits@mozilla.com
push dateWed, 28 Oct 2020 09:24:21 +0000
treeherdermozilla-central@83bf4fd3b1fb [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmarionette-reviewers, whimboo
bugs1671370
milestone84.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1671370 - [marionette] Clarify use of current window global in |element| docstrings r=marionette-reviewers,whimboo Differential Revision: https://phabricator.services.mozilla.com/D94773
testing/marionette/element.js
--- a/testing/marionette/element.js
+++ b/testing/marionette/element.js
@@ -196,18 +196,18 @@ element.Store = class {
   /**
    * Retrieve a DOM {@link Element} or a {@link XULElement} by its
    * unique {@link WebElement} reference.
    *
    * @param {WebElement} webEl
    *     Web element reference to find the associated {@link Element}
    *     of.
    * @param {WindowProxy} win
-   *     Current browsing context, which may differ from the associated
-   *     browsing context of <var>el</var>.
+   *     Current window global, which may differ from the associated
+   *     window global of <var>el</var>.
    *
    * @returns {(Element|XULElement)}
    *     Element associated with reference.
    *
    * @throws {TypeError}
    *     If <var>webEl</var> is not a {@link WebElement}.
    * @throws {NoSuchElementError}
    *     If the web element reference <var>uuid</var> has not been
@@ -785,18 +785,18 @@ element.getElementId = function(el) {
 /**
  * Wrapper around ContentDOMReference.resolve with additional error handling
  * specific to Marionette.
  *
  * @param {ElementIdentifier} id
  *     The identifier generated via ContentDOMReference.get for a DOM element.
  *
  * @param {WindowProxy=} win
- *     Current browsing context, which may differ from the associate
- *     browsing context of <var>el</var>.  When retrieving XUL
+ *     Current window global, which may differ from the associated
+ *     window global of <var>el</var>.  When retrieving XUL
  *     elements, this is optional.
  *
  * @return {Element} The DOM element that the identifier was generated for, or
  *     null if the element does not still exist.
  *
  * @throws {StaleElementReferenceError}
  *     If the element has gone stale, indicating it is no longer
  *     attached to the DOM, or its node document is no longer the
@@ -848,29 +848,29 @@ element.isCollection = function(seq) {
 /**
  * Determines if <var>el</var> is stale.
  *
  * A stale element is an element no longer attached to the DOM or which
  * node document is not the active document of the current browsing
  * context.
  *
  * The currently selected browsing context, specified through
- * <var>window<var>, is a WebDriver concept defining the target
+ * <var>win<var>, is a WebDriver concept defining the target
  * against which commands will run.  As the current browsing context
  * may differ from <var>el</var>'s associated context, an element is
  * considered stale even if it is connected to a living (not discarded)
  * browsing context such as an <tt>&lt;iframe&gt;</tt>.
  *
  * @param {Element=} el
  *     DOM element to check for staleness.  If null, which may be
  *     the case if the element has been unwrapped from a weak
  *     reference, it is always considered stale.
  * @param {WindowProxy=} win
- *     Current browsing context, which may differ from the associate
- *     browsing context of <var>el</var>.  When retrieving XUL
+ *     Current window global, which may differ from the associated
+ *     window global of <var>el</var>.  When retrieving XUL
  *     elements, this is optional.
  *
  * @return {boolean}
  *     True if <var>el</var> is stale, false otherwise.
  */
 element.isStale = function(el, win = undefined) {
   if (typeof win == "undefined") {
     win = el.ownerGlobal;