Skip to content

Commit c831be8

Browse files
committed
Fix issues
1 parent 36d3563 commit c831be8

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

Diff for: wpilibc/src/main/native/include/frc/DutyCycleEncoder.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class DigitalSource;
2222
* PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
2323
* Encoder.
2424
*
25-
* @warning By default, position readings from Get() will be innacurate for up
25+
* @warning By default, position readings from Get() will be inaccurate for up
2626
* to 2 seconds after this object is initialized. Setting the frequency of the
2727
* encoder's output using {@link #setAssumedFrequency(double)} can be used to
2828
* mitigate this, though users should verify the true frequency of the specific
@@ -199,12 +199,12 @@ class DutyCycleEncoder : public wpi::Sendable,
199199
void SetConnectedFrequencyThreshold(int frequency);
200200

201201
/**
202-
* Get the encoder value in rotations.
202+
* Get the encoder value.
203203
*
204204
* @warning This will return inaccurate values for up to 2 seconds after this
205205
* encoder is initialized unless SetAssumedFrequency() is used.
206206
*
207-
* @return the encoder value in rotations
207+
* @return the encoder value scaled by the full range input
208208
*/
209209
double Get() const;
210210

Diff for: wpilibj/src/main/java/edu/wpi/first/wpilibj/DutyCycleEncoder.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* Class for supporting duty cycle/PWM encoders, such as the US Digital MA3 with PWM Output, the
1717
* CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag Encoder.
1818
*
19-
* <p><b>Warning: By default, position readings from {@link #get()} will be innacurate for up to 2
19+
* <p><b>Warning: By default, position readings from {@link #get()} will be inaccurate for up to 2
2020
* seconds after this encoder is initialized.</b> Setting the frequency of the encoder's output
2121
* using {@link #setAssumedFrequency(double)} can be used to mitigate this, though users should
2222
* verify the true frequency of the specific encoder in use as it can vary between devices.
@@ -142,12 +142,12 @@ private double mapSensorRange(double pos) {
142142
}
143143

144144
/**
145-
* Get the encoder value in rotations.
145+
* Get the encoder value.
146146
*
147147
* <p><b> Warning: This will return inaccurate values for up to 2 seconds after this encoder is
148148
* initialized unless {@link #setAssumedFrequency(double)} is used.</b>
149149
*
150-
* @return the encoder value in rotations
150+
* @return the encoder value scaled by the full range input
151151
*/
152152
public double get() {
153153
if (m_simPosition != null) {

0 commit comments

Comments
 (0)