add docstring to class Workspace

Propulsive-Landing · Nov 17, 2020 · 98074c6 · 98074c6
1 parent a7eb4e9
commit 98074c6
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/workspace.hh b/src/workspace.hh
@@ -9,6 +9,15 @@
 #include "Wire.h"  // Arduino library
 
 
+/* Workspace
+ *
+ * This class acts as a container for all of the variables which change
+ * throughout the flight. This keeps things tidy by keeping them out of
+ * the top of main.ino. An instance of this class is created at the top
+ * of main.ino.
+ * 
+ * Constant variables should be placed in mission_constants.hh.
+ */
 class Workspace
 {
     public: