renamed python package from example to less ambiguous gtsam_example

Author: varunagrawal

example/CMakeLists.txt

@@ -1,9 +1,9 @@
 # This file should be used as a template for creating new projects with Python wrapping using the CMake tools
 
 ###################################################################################
-# 1. To create your own project, replace "example" with the actual name of your project
+# 1. To create your own project, replace "gtsam_example" with the actual name of your project
 cmake_minimum_required(VERSION 3.0)
-project(example CXX C)
+project(gtsam_example CXX C)
 
 ###################################################################################
 # 2. Set the python version
@@ -63,7 +63,7 @@ configure_file(${PROJECT_SOURCE_DIR}/setup.py ${PROJECT_BINARY_DIR}/cython/setup
 
 ###################################################################################
 # 10. Build Cython wrapper (CMake tracks the dependecy to link with GTSAM through our project's static library)
-wrap_and_install_library_cython("example.h" # interface_header
+wrap_and_install_library_cython("gtsam_example.h" # interface_header
                                 "" # extra imports
                                 "./${PROJECT_NAME}" # install path
                                 "gtsam;${PROJECT_NAME}"  # library to link with

example/example.h example/gtsam_example.hexample/example.h renamed to example/gtsam_example.h

@@ -10,22 +10,23 @@
  * -------------------------------------------------------------------------- */
 
 /**
- * @file     example.h
+ * @file     gtsam_example.h
  * @brief    Example wrapper interface file for Python
  * @author   Varun Agrawal
  */
 
-// This is an interface file for automatic Python wrapper generation.  See
-// gtsam.h for full documentation and more examples.
+// This is an interface file for automatic Python wrapper generation.
+// See gtsam.h for full documentation and more examples.
 
 #include <src/greeting.h>
 
+// The namespace should be the same as in the c++ source code.
 namespace example {
 
 class Greeting {
-    Greeting();
-    void sayHello() const;
-    void sayGoodbye() const;
+  Greeting();
+  void sayHello() const;
+  void sayGoodbye() const;
 };
 
-}
+}  // namespace example