From 98074c6f84e8c761ba4f35cdcd9342abf0761ff7 Mon Sep 17 00:00:00 2001 From: Mike Bernard Date: Mon, 16 Nov 2020 19:07:40 -0500 Subject: [PATCH] add docstring to class Workspace --- src/workspace.hh | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/workspace.hh b/src/workspace.hh index 594796e..3fcf705 100644 --- 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: