Merge pull request #359 from hernandik/master

Clarify the parameter usage of 'allow_redirects' in documentation

Author: lucagiove

doc/RequestsLibrary.html

@@ -177,7 +177,7 @@ def session_less_get(self, url, params=None,
         | ``file-tuple`` | can be a 2-tuple ``('filename', fileobj)``, 3-tuple ``('filename', fileobj, 'content_type')`` or a 4-tuple ``('filename', fileobj, 'content_type', custom_headers)``, where ``'content-type'`` is a string defining the content type of the given file and ``custom_headers`` a dict-like object containing additional headers to add for the file. |
         | ``auth`` | Auth tuple to enable Basic/Digest/Custom HTTP Auth. |
         | ``timeout`` | How many seconds to wait for the server to send data before giving up, as a float, or a ``(connect timeout, read timeout)`` tuple. |
-        | ``allow_redirects`` | Boolean. Enable/disable GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to ``${True}``. |
+        | ``allow_redirects`` | Boolean. Enable/disable (values ``${True}`` or ``${False}``) GET/OPTIONS/POST/PUT/PATCH/DELETE/HEAD redirection. Defaults to ``${True}``. |
         | ``proxies`` | Dictionary mapping protocol or protocol and host to the URL of the proxy (e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'}) |
         | ``verify``  | Either a boolean, in which case it controls whether we verify the server's TLS certificate, or a string, in which case it must be a path to a CA bundle to use. Defaults to ``${True}``. Warning: if a session has been created with ``verify=${False}`` any other requests will not verify the SSL certificate. |
         | ``stream`` | if ``${False}``, the response content will be immediately downloaded. |
@@ -256,8 +256,8 @@ def session_less_head(self, url,
 
         The endpoint used to retrieve the HTTP headers is the ``url``.
 
-        ``allow_redirects`` parameter is not provided, it will be set to `False` (as
-        opposed to the default behavior).
+        ``allow_redirects`` parameter is not provided, it will be set to ``${False}`` (as
+        opposed to the default behavior ``${True}``).
 
         By default this keyword fails if a status code with error values is returned in the response,
         this behavior can be modified using the ``expected_status`` and ``msg`` parameters,

src/RequestsLibrary/RequestsKeywords.py

@@ -154,8 +154,8 @@ def head_on_session(self, alias, url,
         Session will be identified using the ``alias`` name.
         The endpoint used to retrieve the HTTP headers is the ``url``.
 
-        ``allow_redirects`` parameter is not provided, it will be set to `False` (as
-        opposed to the default behavior).
+        ``allow_redirects`` parameter is not provided, it will be set to ``${False}`` (as
+        opposed to the default behavior ``${True}``).
 
         By default this keyword fails if a status code with error values is returned in the response,
         this behavior can be modified using the ``expected_status`` and ``msg`` parameters,

src/RequestsLibrary/RequestsOnSessionKeywords.py

@@ -140,7 +140,7 @@ def create_session(self,
 
         ``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.
 
-        ``debug`` Enable http verbosity option more information
+        ``debug`` Enable http verbosity option more information. Valid values are 0, 1, 2 ...
                 https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel
 
         ``max_retries`` Number of maximum retries each connection should attempt.
@@ -227,7 +227,7 @@ def create_client_cert_session(
         ``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.
                  Defaults to False.
 
-        ``debug`` Enable http verbosity option more information
+        ``debug`` Enable http verbosity option more information. Valid values are 0, 1, 2 ...
                 https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel
 
         ``max_retries`` Number of maximum retries each connection should attempt.
@@ -315,7 +315,7 @@ def create_custom_session(
         ``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.
                  Defaults to False.
 
-        ``debug`` Enable http verbosity option more information
+        ``debug`` Enable http verbosity option more information. Valid values are 0, 1, 2 ...
                 https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel
 
         ``max_retries`` Number of maximum retries each connection should attempt.
@@ -397,7 +397,7 @@ def create_digest_session(
         ``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.
                  Defaults to False.
 
-        ``debug`` Enable http verbosity option more information
+        ``debug`` Enable http verbosity option more information. Valid values are 0, 1, 2 ...
                 https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel
 
         ``max_retries`` Number of maximum retries each connection should attempt.
@@ -476,7 +476,7 @@ def create_ntlm_session(
         ``verify`` Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.
                  Defaults to False.
 
-        ``debug`` Enable http verbosity option more information
+        ``debug`` Enable http verbosity option more information. Valid values are 0, 1, 2 ...
                 https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel
 
         ``max_retries`` Number of maximum retries each connection should attempt.