Skip to content

Commit

Permalink
Polished docs for 4.0.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Owez committed Dec 27, 2022
1 parent 3c92a63 commit ee0fe7a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ use pid::Pid;
let mut pid = Pid::new(15.0, 100.0);
pid.p(10.0, 100.0);

// Input a mesurement with an error of 5.0 from our setpoint
// Input a measurement with an error of 5.0 from our setpoint
let output = pid.next_control_output(10.0);

// Show that the error is correct by multiplying by our kp
Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//! let mut pid = Pid::new(15.0, 100.0);
//! pid.p(10.0, 100.0);
//!
//! // Input a mesurement with an error of 5.0 from our setpoint
//! // Input a measurement with an error of 5.0 from our setpoint
//! let output = pid.next_control_output(10.0);
//!
//! // Show that the error is correct by multiplying by our kp
Expand Down Expand Up @@ -70,7 +70,7 @@ use serde::{Deserialize, Serialize};
/// ```rust
/// use pid::Pid;
///
/// // Create full PID controler
/// // Create full PID controller
/// let mut full_controller = Pid::new(15.0, 100.0);
/// full_controller.p(10.0, 100.0).i(4.5, 100.0).d(0.25, 100.0);
///
Expand Down

0 comments on commit ee0fe7a

Please sign in to comment.