Commit 594daa7b authored by Maja Frydrychowicz's avatar Maja Frydrychowicz
Browse files

Bug 1671370 - [marionette] Clarify use of current window global in |element|... 

Bug 1671370 - [marionette] Clarify use of current window global in |element| docstrings r=marionette-reviewers,whimboo

Differential Revision: https://phabricator.services.mozilla.com/D94773
parent c3699acd

testing/marionette/element.js

+7 −7
Original line number Diff line number Diff line
@@ -201,8 +201,8 @@ element.Store = class { 
   *     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.
@@ -790,8 +790,8 @@ element.getElementId = function(el) { 
 *     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
@@ -853,7 +853,7 @@ element.isCollection = function(seq) { 
 * 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)
@@ -864,8 +864,8 @@ element.isCollection = function(seq) { 
 *     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}