Merge pull request baijum#86 from j-n-c/docs_revision

baijum · web-flow · commit 05fd35e30ceb · 2019-11-20T11:49:36.000+05:30
Some Documentation fixes
diff --git a/source/getting-started.rst b/source/getting-started.rst
@@ -54,8 +54,8 @@ Next, the instance of Firefox WebDriver is created.
 The `driver.get` method will navigate to a page given by the URL.
 WebDriver will wait until the page has fully loaded (that is, the
 "onload" event has fired) before returning control to your test or
-script.  It's worth noting that if your page uses a lot of AJAX on
-load then WebDriver may not know when it has completely loaded.::
+script. *Be aware that if your page uses a lot of AJAX on
+load then WebDriver may not know when it has completely loaded*::
 
   driver.get("http://www.python.org")
 
@@ -191,8 +191,8 @@ local reference to the driver object created in `setUp` method.
 The `driver.get` method will navigate to a page given by the URL.
 WebDriver will wait until the page has fully loaded (that is, the
 "onload" event has fired) before returning control to your test or
-script.  It's worth noting that if your page uses a lot of AJAX on
-load then WebDriver may not know when it has completely loaded.::
+script. *Be aware that if your page uses a lot of AJAX on
+load then WebDriver may not know when it has completely loaded*::
 
           driver.get("http://www.python.org")
 
diff --git a/source/locating-elements.rst b/source/locating-elements.rst
@@ -29,8 +29,11 @@ methods to locate elements in a page:
 
 
 Apart from the public methods given above, there are two private
-methods which might be useful with locators in page objects.  These
-are the two private methods: `find_element` and `find_elements`.
+methods which might be useful for locating page elements:
+
+- `find_element`
+- `find_elements`
+
 
 Example usage::
 
@@ -55,10 +58,10 @@ These are the attributes available for `By` class::
 Locating by Id
 ~~~~~~~~~~~~~~
 
-Use this when you know `id` attribute of an element.  With this
-strategy, the first element with the `id` attribute value matching the
-location will be returned.  If no element has a matching `id`
-attribute, a ``NoSuchElementException`` will be raised.
+Use this when you know the `id` attribute of an element. With this
+strategy, the first element with a matching `id` attribute will 
+be returned.  If no element has a matching `id` attribute, 
+a ``NoSuchElementException`` will be raised.
 
 For instance, consider this page source::
 
@@ -80,10 +83,10 @@ The form element can be located like this::
 Locating by Name
 ~~~~~~~~~~~~~~~~
 
-Use this when you know `name` attribute of an element.  With this
-strategy, the first element with the `name` attribute value matching
-the location will be returned.  If no element has a matching `name`
-attribute, a ``NoSuchElementException`` will be raised.
+Use this when you know the `name` attribute of an element.  With this
+strategy, the first element with a matching `name` attribute will 
+be returned.  If no element has a matching `name` attribute, 
+a ``NoSuchElementException`` will be raised.
 
 For instance, consider this page source::
 
@@ -115,8 +118,8 @@ Locating by XPath
 XPath is the language used for locating nodes in an XML document.  As
 HTML can be an implementation of XML (XHTML), Selenium users can
 leverage this powerful language to target elements in their web
-applications.  XPath extends beyond (as well as supporting) the simple
-methods of locating by id or name attributes, and opens up all sorts
+applications.  XPath supports the simple methods of locating by 
+id or name attributes and extends them by opening up all sorts
 of new possibilities such as locating the third checkbox on the page.
 
 One of the main reasons for using XPath is when you don't have a
@@ -157,34 +160,30 @@ The form elements can be located like this::
 
 2. First form element in the HTML
 
-3. The form element with attribute named `id` and the value `loginForm`
+3. The form element with attribute `id` set to `loginForm`
 
 The username element can be located like this::
 
   username = driver.find_element_by_xpath("//form[input/@name='username']")
   username = driver.find_element_by_xpath("//form[@id='loginForm']/input[1]")
   username = driver.find_element_by_xpath("//input[@name='username']")
 
-1. First form element with an input child element with attribute named
-   `name` and the value `username`
+1. First form element with an input child element with `name` set to `username`
 
-2. First input child element of the form element with attribute named
-   `id` and the value `loginForm`
+2. First input child element of the form element with attribute `id` set to `loginForm`
 
-3. First input element with attribute named 'name' and the value
-   `username`
+3. First input element with attribute `name` set to `username`
 
 The "Clear" button element can be located like this::
 
   clear_button = driver.find_element_by_xpath("//input[@name='continue'][@type='button']")
   clear_button = driver.find_element_by_xpath("//form[@id='loginForm']/input[4]")
 
 
-1. Input with attribute named `name` and the value `continue` and
-   attribute named `type` and the value `button`
+1. Input with attribute `name` set to `continue` and
+   attribute `type` set to `button`
 
-2. Fourth input child element of the form element with attribute named
-   `id` and value `loginForm`
+2. Fourth input child element of the form element with attribute `id` set to `loginForm`
 
 These examples cover some basics, but in order to learn more, the
 following references are recommended:
@@ -212,9 +211,9 @@ discovering the XPath of an element:
 Locating Hyperlinks by Link Text
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use this when you know link text used within an anchor tag.  With this
-strategy, the first element with the link text value matching the
-location will be returned.  If no element has a matching link text
+Use this when you know the link text used within an anchor tag. With this
+strategy, the first element with the link text matching the provided value 
+will be returned.  If no element has a matching link text
 attribute, a ``NoSuchElementException`` will be raised.
 
 For instance, consider this page source::
@@ -258,9 +257,9 @@ The heading (h1) element can be located like this::
 Locating Elements by Class Name
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use this when you want to locate an element by class attribute name.
-With this strategy, the first element with the matching class attribute
-name will be returned.  If no element has a matching class attribute name,
+Use this when you want to locate an element by class name.
+With this strategy, the first element with the matching class name 
+attribute will be returned.  If no element has a matching class name attribute,
 a ``NoSuchElementException`` will be raised.
 
 For instance, consider this page source::
@@ -278,9 +277,9 @@ The "p" element can be located like this::
 Locating Elements by CSS Selectors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Use this when you want to locate an element by CSS selector syntax.
-With this strategy, the first element with the matching CSS selector
-will be returned.  If no element has a matching CSS selector,
+Use this when you want to locate an element using CSS selector syntax.
+With this strategy, the first element matching the given CSS selector
+will be returned.  If no element matches the provided CSS selector,
 a ``NoSuchElementException`` will be raised.
 
 For instance, consider this page source::
diff --git a/source/navigating.rst b/source/navigating.rst
@@ -12,8 +12,8 @@ link.  The normal way to do this is by calling ``get`` method:
 
 WebDriver will wait until the page has fully loaded (that is, the
 ``onload`` event has fired) before returning control to your test or
-script.  It's worth noting that if your page uses a lot of AJAX on
-load then WebDriver may not know when it has completely loaded.  If
+script.  *Be aware that if your page uses a lot of AJAX on
+load then WebDriver may not know when it has completely loaded*.  If
 you need to ensure such pages are fully loaded then you can use
 :ref:`waits <waits>`.
 
@@ -223,8 +223,8 @@ one browser over another.
 Cookies
 ~~~~~~~
 
-Before we leave these next steps, you may be interested in
-understanding how to use cookies.  First of all, you need to be on the
+Before moving to the next section of the tutorial, you may be interested in
+understanding how to use cookies. First of all, you need to be on the
 domain that the cookie will be valid for:
 
 ::
diff --git a/source/waits.rst b/source/waits.rst
@@ -3,7 +3,7 @@
 Waits
 -----
 
-These days most of the web apps are using AJAX techniques.  When a
+These days, most of the web apps are using AJAX techniques.  When a
 page is loaded by the browser, the elements within that page may load at
 different time intervals.  This makes locating elements difficult: if
 an element is not yet present in the DOM, a locate function will raise
@@ -47,12 +47,12 @@ accomplished.
       driver.quit()
 
 
-This waits up to 10 seconds before throwing a TimeoutException unless 
-it finds the element to return within 10 seconds.  WebDriverWait
-by default calls the ExpectedCondition every 500 milliseconds until it
-returns successfully.  A successful return is for ExpectedCondition
-type is Boolean return true or not null return value for all other
-ExpectedCondition types.
+In the code above, Selenium will wait for a maximum of 10 seconds for an element
+matching the given criteria to be found. If no element is found in that time, 
+a TimeoutException is thrown. By default, WebDriverWait calls the 
+ExpectedCondition every 500 milliseconds until it returns success. 
+ExpectedCondition will return `true` (Boolean) in case of success or `not null` 
+if it fails to locate an element.
 
 **Expected Conditions**
 
@@ -127,7 +127,7 @@ Implicit Waits
 
 An implicit wait tells WebDriver to poll the DOM for a certain
 amount of time when trying to find any element (or elements)
-not immediately available.  The default setting is 0.  Once set, the
+not immediately available.  The default setting is 0 (zero).  Once set, the
 implicit wait is set for the life of the WebDriver object.
 
 ::
