change all the pass defense constants to finals

[3501/stronghold-2016] / notes-explanation.txt

open this file with eclipse for best display.

(some programs like notepad will display boxes instead of newlines)

notes/danny.org and notes/cindy.org are files to help danny and cindy
keep "org"anized. they each have 3 secions in them. those sections are
"todo", "doing", and "done". each section contains bullet points for
each thing a dev should be keeping track of. here's an example name.org
file:

==== begin example name.org file ====

* todo
  * make PID method that takes input from gyro and turns robot
    * get input from gyro printing in riolog
    * make method that turns robot in place based only on
      difference term
  * write skeleton for pneumatic piston to extend defense arm
* doing
  * make PID method that takes input from gyro and turns robot
    * get input from gyro printing in riolog
* done
  * drive in a square using dead reckoning

==== end example name.org file ====

each bullet point without sub-points should be one commit. for example,
see commit 56c148bd962f3aadfc4595bb5473fa7d18e55b78.  let's have a look
at it, then i'll point out some important points.
here's the diff from that commit:

==== begin diff 56c148bd ====
------------------------------- notes/cindy.org -------------------------------
index 09b3585..00acb0c 100644
@@ -1,16 +1,16 @@
 * todo
   * figure out where the frame perimeter starts, and where the arm is mounted
     relative to that
   * find out actual arm and hand length, as well as the height at which the arm
     is mounted
-  * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement"
   * change method "getArmHeight" to "getArmVerticalDisplacement"
   * for getArmHorizontalDisplacement figure out if measurements are all in 
     inches
 * doing
-  * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement"
+  * change method "getArmHeight" to "getArmVerticalDisplacement"
 * done
   * code review
   * change arm and hand to "armHorizontal/armVertical" and "handHorizontal/
     handVertical"
+  * change method "getArmHorizontalDist" to "getArmHorizontalDisplacement"
   
-------- src/org/usfirst/frc/team3501/robot/subsystems/DefenseArm.java --------
index 020d51b..401f09e 100755
@@ -90,35 +90,35 @@ public class DefenseArm extends Subsystem {
         * Math.cos(getHandPotAngle());
     return (armHorizontalDisplacement + handHorizontalDisplacement);
   }
 
-  public double getArmHeight() {
+  public double getArmVerticalDisplacement() {
     double armMounted = Constants.DefenseArm.ARM_MOUNTED_HEIGHT;
     double armVerticalDisplacement = Constants.DefenseArm.ARM_LENGTH
         * Math.sin(getArmPotAngle());

==== end diff 56c148bd ====

in this diff, cindy moved a few bullet points.  they are

* change method "getArmHorizontalDist" to "getArmHorizontalDisplacement"

and

* change method "getArmHeight" to "getArmVerticalDisplacement"

the first bullet moved from "todo" to "doing" and the second moved
from "doing" to "done".  the first one, that moved from "todo" to
"doing" is moved to the "doing" section because it describes what this
commit is doing.  it may take several commits to complete a bullet
point.  in that case, the bullet point would stay in the "doing"
section for all the commits.

the second bullet moved from "doing" to "done" because it's done by
the time this commit is made.

also included in commit 56c148bd is the code that implements the
bullet point. notice how small the commit is, and also how quickly it
was made. the 2 commits before and the one after happen over the
course of 3 minutes and 11 seconds.