From efe2eb046c5f7278303b3813d438cc475d766754 Mon Sep 17 00:00:00 2001
From: Isse <isidornie@gmail.com>
Date: Mon, 10 Apr 2023 22:22:50 +0200
Subject: [PATCH] add comment about a pure-proportional controller

---
 common/src/comp/agent.rs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/common/src/comp/agent.rs b/common/src/comp/agent.rs
index 24a01fc26c..cb34b91852 100644
--- a/common/src/comp/agent.rs
+++ b/common/src/comp/agent.rs
@@ -907,6 +907,7 @@ impl<F: Fn(Vec3<f32>, Vec3<f32>) -> f32, const NUM_SAMPLES: usize> PidController
 /// Get the PID coefficients associated with some Body, since it will likely
 /// need to be tuned differently for each body type
 pub fn pid_coefficients(body: &Body) -> Option<(f32, f32, f32)> {
+    // A pure-proportional controller is { kp: 1.0, ki: 0.0, kd: 0.0 }
     match body {
         Body::Ship(ship::Body::DefaultAirship) => {
             let kp = 1.0;