Final touch up getting ready for TR

Author: jima80525

python-bindings/overview_article/cffi_test.py

@@ -2,7 +2,7 @@
 import cffi_example
 
 if __name__ == "__main__":
-    # sample data for our call:
+    # Sample data for our call:
     x, y = 6, 2.3
 
     answer = cffi_example.lib.cmult(x, y)

python-bindings/overview_article/ctypes_test.py

@@ -5,11 +5,11 @@
 
 
 if __name__ == "__main__":
-    # load the shared library into c types.
+    # Load the shared library into c types.
     libname = pathlib.Path().absolute() / "libcmult.so"
     c_lib = ctypes.CDLL(libname)
 
-    # sample data for our call:
+    # Sample data for our call:
     x, y = 6, 2.3
 
     # This will not work:

python-bindings/overview_article/cython_test.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 import cython_example
 
-# sample data for our call:
+# Sample data for our call
 x, y = 6, 2.3
 
 answer = cython_example.pymult(x, y)

python-bindings/overview_article/pybind11_test.py

@@ -1,9 +1,8 @@
 #!/usr/bin/env python
 import pybind11_example
 
-
 if __name__ == "__main__":
-    # sample data for our call:
+    # Sample data for our call:
     x, y = 6, 2.3
 
     answer = pybind11_example.cpp_function(x, y)

python-bindings/overview_article/tasks.py

@@ -7,7 +7,7 @@
 
 @invoke.task
 def clean(c):
-    """ Remove any built objects. """
+    """ Remove any built objects """
     for pattern in ["*.o", "*.so", "cffi_example* cython_wrapper.cpp", ]:
         c.run("rm -rf {}".format(pattern))
 
@@ -17,7 +17,7 @@ def print_banner(msg):
 
 @invoke.task
 def build_cmult(c):
-    """ Compile and link the shared library (DLL) for the sample C++ code."""
+    """ Build the shared library for the sample C code """
     print_banner("Building C Library")
     invoke.run("gcc -c -Wall -Werror -fpic cmult.c -I /usr/include/python3.7")
     invoke.run("gcc -shared -o libcmult.so cmult.o")
@@ -26,11 +26,13 @@ def build_cmult(c):
 
 @invoke.task(build_cmult)
 def test_ctypes(c):
+    """ Run the script to test ctypes """
     print_banner("Testing ctypes Module")
     invoke.run("python3 ctypes_test.py", pty=True)
 
 @invoke.task(build_cmult)
 def build_cffi(c):
+    """ Build the CFFI Python bindings """
     print_banner("Building CFFI Module")
     ffi = cffi.FFI()
 
@@ -57,13 +59,14 @@ def build_cffi(c):
 
 @invoke.task()
 def test_cffi(c):
+    """ Run the script to test CFFI """
     print_banner("Testing CFFI Module")
     invoke.run("python3 cffi_test.py", pty=True)
 
 
 @invoke.task()
 def build_cppmult(c):
-    """ Compile and link the shared library (DLL) for the sample C++ code."""
+    """ Build the shared library for the sample C++ code """
     print_banner("Building C++ Library")
     invoke.run(
         "g++ -O3 -Wall -Werror -shared -std=c++11 -fPIC cppmult.cpp -o libcppmult.so "
@@ -81,35 +84,38 @@ def compile_python_module(cpp_name, extension_name):
 
 @invoke.task(build_cppmult)
 def build_pybind11(c):
-    """ compile and link the pybind11 wrapper library """
+    """ Build the pybind11 wrapper library """
     print_banner("Building PyBind11 Module")
     compile_python_module("pybind11_wrapper.cpp", "pybind11_example")
     print("* Complete")
 
 @invoke.task()
 def test_pybind11(c):
+    """ Run the script to test PyBind11 """
     print_banner("Testing PyBind11 Module")
     invoke.run("python3 pybind11_test.py", pty=True)
 
 
 @invoke.task(build_cppmult)
 def build_cython(c):
-    """ build the cython extension module """
+    """ Build the cython extension module """
     print_banner("Building Cython Module")
-    # run cython on the pyx file to create a .cpp file
+    # Run cython on the pyx file to create a .cpp file
     invoke.run("cython --cplus -3 cython_example.pyx -o cython_wrapper.cpp")
 
-    # compile and link the cython wrapper library
+    # Compile and link the cython wrapper library
     compile_python_module("cython_wrapper.cpp", "cython_example")
     print("* Complete")
 
 @invoke.task()
 def test_cython(c):
+    """ Run the script to test Cython """
     print_banner("Testing Cython Module")
     invoke.run("python3 cython_test.py", pty=True)
 
 @invoke.task(clean, build_cmult, test_ctypes, build_cffi, test_cffi,
              build_pybind11, test_pybind11, build_cython, test_cython)
 def all(c):
+    """ Build and run all tests """
     pass