fixing various typos

paigesrossi · paigesrossi · commit e2f4b4ca2fd1 · 2020-12-14T11:09:59.000-08:00
diff --git a/app/click/examples/eg001_create_clickwrap/controller.py b/app/click/examples/eg001_create_clickwrap/controller.py
@@ -48,18 +48,18 @@ def worker(args):
             document_display="document"
         )
 
-        # read file from a local directory
+        # Read file from a local directory
         # The reads could raise an exception if the file is not available!
         with open(path.join(demo_docs_path, DS_CONFIG["doc_terms_pdf"]),
                   "rb") as file:
             doc_docx_bytes = file.read()
         doc_b64 = base64.b64encode(doc_docx_bytes).decode("ascii")
 
         # Step 3. Create a document model.
-        document = Document(  # create the DocuSign document object
+        document = Document(  # Create the DocuSign document object
             document_base64=doc_b64,
-            document_name="Terms of Service",  # can be different from actual file name
-            file_extension="pdf",  # many different document types are accepted
+            document_name="Terms of Service",  # Can be different from actual file name
+            file_extension="pdf",  # Many different document types are accepted
             order=0
         )
 
diff --git a/app/click/examples/eg001_create_clickwrap/views.py b/app/click/examples/eg001_create_clickwrap/views.py
@@ -11,7 +11,7 @@
 from app.ds_config import DS_CONFIG
 from app.error_handlers import process_error
 
-eg = "eg001"  # reference (and url) for this example
+eg = "eg001"  # Reference (and URL) for this example
 eg001 = Blueprint("eg001", __name__)
 
 
@@ -37,7 +37,7 @@ def create_clickwrap():
     except ApiException as err:
         return process_error(err)
 
-    # Save for use by other examples which need an clickwrap params.
+    # Save for use by other examples which need a clickwrap parameter.
     session["clickwrap_id"] = clickwrap_id
     session["clickwrap_name"] = clickwrap_name
     session["clickwrap_is_active"] = False
diff --git a/app/click/examples/eg002_activate_clickwrap/views.py b/app/click/examples/eg002_activate_clickwrap/views.py
@@ -11,7 +11,7 @@
 from app.ds_config import DS_CONFIG
 from app.error_handlers import process_error
 
-eg = "eg002"  # reference (and url) for this example
+eg = "eg002"  # Reference (and URL) for this example
 eg002 = Blueprint("eg002", __name__)
 
 
diff --git a/app/click/examples/eg003_test_clickwrap/views.py b/app/click/examples/eg003_test_clickwrap/views.py
@@ -8,7 +8,7 @@
 from app.docusign import authenticate
 from app.ds_config import DS_CONFIG
 
-eg = "eg003"  # reference (and url) for this example
+eg = "eg003"  # Reference (and URL) for this example
 eg003 = Blueprint("eg003", __name__)
 
 
diff --git a/app/click/examples/eg004_embed_clickwrap/views.py b/app/click/examples/eg004_embed_clickwrap/views.py
@@ -1,4 +1,4 @@
-"""Example 004: Embeding a clickwrap"""
+"""Example 004: Embedding a clickwrap"""
 
 from os import path
 
@@ -8,7 +8,7 @@
 from app.docusign import authenticate
 from app.ds_config import DS_CONFIG
 
-eg = "eg004"  # reference (and url) for this example
+eg = "eg004"  # Reference (and URL) for this example
 eg004 = Blueprint("eg004", __name__)
 
 
@@ -26,7 +26,7 @@ def embed_clickwrap():
     # 2. Render template
     return render_template(
         "eg004_embed_clickwrap.html",
-        title="Embeding a clickwrap",
+        title="Embedding a clickwrap",
         account_id=args.get('account_id'),
         client_user_id=DS_CONFIG.get('signer_email'),
         clickwrap_id=args.get('clickwrap_id'),
diff --git a/app/click/examples/eg005_create_new_clickwrap_version/controller.py b/app/click/examples/eg005_create_new_clickwrap_version/controller.py
@@ -49,18 +49,18 @@ def worker(args):
             send_to_email=False
         )
 
-        # read file from a local directory
+        # Read file from a local directory
         # The reads could raise an exception if the file is not available!
         with open(path.join(demo_docs_path, DS_CONFIG["doc_terms_pdf"]),
                   "rb") as file:
             doc_docx_bytes = file.read()
         doc_b64 = base64.b64encode(doc_docx_bytes).decode("ascii")
 
         # Step 3. Create a document model.
-        document = Document(  # create the DocuSign document object
+        document = Document(  # Create the DocuSign document object
             document_base64=doc_b64,
-            document_name="Terms of Service", # can be different from actual file name
-            file_extension="pdf",  # many different document types are accepted
+            document_name="Terms of Service", # Can be different from actual file name
+            file_extension="pdf",  # Many different document types are accepted
             order=0
         )
 
diff --git a/app/click/examples/eg005_create_new_clickwrap_version/views.py b/app/click/examples/eg005_create_new_clickwrap_version/views.py
@@ -11,7 +11,7 @@
 from app.ds_config import DS_CONFIG
 from app.error_handlers import process_error
 
-eg = "eg005"  # reference (and url) for this example
+eg = "eg005"  # Reference (and URL) for this example
 eg005 = Blueprint("eg005", __name__)
 
 
diff --git a/app/click/examples/eg006_list_clickwraps/views.py b/app/click/examples/eg006_list_clickwraps/views.py
@@ -11,7 +11,7 @@
 from app.ds_config import DS_CONFIG
 from app.error_handlers import process_error
 
-eg = "eg006"  # reference (and url) for this example
+eg = "eg006"  # Reference (and URL) for this example
 eg006 = Blueprint("eg006", __name__)
 
 
@@ -45,7 +45,7 @@ def clickwrap_list():
 @eg006.route("/eg006", methods=["GET"])
 @authenticate(eg=eg)
 def get_view():
-    """responds with the form for the example"""
+    """Responds with the form for the example"""
     return render_template(
         "eg006_list_clickwraps.html",
         title="Getting a list of clickwraps",
diff --git a/app/click/examples/eg007_clickwrap_responses/views.py b/app/click/examples/eg007_clickwrap_responses/views.py
@@ -11,7 +11,7 @@
 from app.ds_config import DS_CONFIG
 from app.error_handlers import process_error
 
-eg = "eg007"  # reference (and url) for this example
+eg = "eg007"  # Reference (and URL) for this example
 eg007 = Blueprint("eg007", __name__)
 
 
@@ -45,7 +45,7 @@ def clickwrap_responses():
 @eg007.route("/eg007", methods=["GET"])
 @authenticate(eg=eg)
 def get_view():
-    """responds with the form for the example"""
+    """Responds with the form for the example"""
     return render_template(
         "eg007_clickwrap_responses.html",
         title="Getting clickwrap responses",
diff --git a/app/click/templates/eg004_embed_clickwrap.html b/app/click/templates/eg004_embed_clickwrap.html
@@ -1,5 +1,5 @@
 <!-- extend base layout --> {% extends "base.html" %}  {% block content %}
-<h4>4. Enbeding a clickwrap</h4>
+<h4>4. Embedding a clickwrap</h4>
 <p>This example demonstrates how to use DocuSign Click to embed an
     existing clickwrap in your website.
 </p>
