Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos with cspell #6972

Merged
merged 4 commits into from
Aug 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README-CMAKE.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ After that, run `cmake --build .` to create your JAR file. To execute the JAR fi

## Using vendordeps

Vendordeps are not included as part of the `wpilib` CMake package. However, if you want to use a vendordep, you need to use `find_package(VENDORDEP)`, where `VENDORDEP` is the name of the vendordep (case-sensitive), like `xrpVendordep` or `romiVenderdep`. Note that wpilibNewCommands, while a vendordep in normal robot projects, is not built as a vendordep in CMake, and is instead included as part of the `wpilib` CMake package. After you used `find_package`, you can reference the vendordep library like normal, either by using `target_link_libraries` for C++ or `add_jar` for Java.
Vendordeps are not included as part of the `wpilib` CMake package. However, if you want to use a vendordep, you need to use `find_package(VENDORDEP)`, where `VENDORDEP` is the name of the vendordep (case-sensitive), like `xrpVendordep` or `romiVendordep`. Note that wpilibNewCommands, while a vendordep in normal robot projects, is not built as a vendordep in CMake, and is instead included as part of the `wpilib` CMake package. After you used `find_package`, you can reference the vendordep library like normal, either by using `target_link_libraries` for C++ or `add_jar` for Java.

## Troubleshooting
Below are some common issues that are run into when building.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
import java.util.function.Consumer;

/**
* An event listener. This calls back to a desigated callback function when an event matching the
* An event listener. This calls back to a designated callback function when an event matching the
* specified mask is generated by the library.
*/
public class VideoListener implements AutoCloseable {
Expand Down
2 changes: 1 addition & 1 deletion cscore/src/main/native/include/cscore_cv.h
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ inline void CvSource::PutFrame(cv::Mat& image) {
int channels = finalImage.channels();
VideoMode::PixelFormat format;
if (channels == 1) {
// 1 channel is assumed Graysacle
// 1 channel is assumed Grayscale
format = VideoMode::PixelFormat::kGray;
} else if (channels == 2) {
// 2 channels is assumed YUYV
Expand Down
4 changes: 2 additions & 2 deletions cscore/src/main/native/include/cscore_oo.h
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ class VideoCamera : public VideoSource {
void SetWhiteBalanceManual(int value);

/**
* Set the exposure to auto aperature.
* Set the exposure to auto aperture.
*/
void SetExposureAuto();

Expand Down Expand Up @@ -1148,7 +1148,7 @@ class VideoEvent : public RawEvent {
};

/**
* An event listener. This calls back to a desigated callback function when
* An event listener. This calls back to a designated callback function when
* an event matching the specified mask is generated by the library.
*/
class VideoListener {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
/**
* Addressable LED HAL JNI Methods.
*
* @see "hal/AdressableLED.h"
* @see "hal/AddressableLED.h"
*/
public class AddressableLEDJNI extends JNIWrapper {
/**
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/java/edu/wpi/first/hal/AnalogGyroJNI.java
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ public static native void setAnalogGyroVoltsPerDegreePerSecond(
* <p>Can be used to not repeat a calibration but reconstruct the gyro object.
*
* @param handle the gyro handle
* @return the gryo offset
* @return the gyro offset
* @see "HAL_GetAnalogGyroOffset"
*/
public static native double getAnalogGyroOffset(int handle);
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/java/edu/wpi/first/hal/AnalogJNI.java
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ public static native void setAnalogTriggerFiltered(
public static native boolean getAnalogTriggerOutput(int analogTriggerHandle, int type);

/**
* Get the FPGA index for the AnlogTrigger.
* Get the FPGA index for the AnalogTrigger.
*
* @param analogTriggerHandle the trigger handle
* @return the FPGA index
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ public static AllianceStationID getAllianceStation() {
* @param rawAxesArray all joystick axes as int
* @param povsArray all povs
* @param buttonsAndMetadata array of long joystick axes count, long joystick povs count, long
* jostick buttons count, long joystick buttons values
* joystick buttons count, long joystick buttons values
* @see "HAL_GetAllJoystickData"
*/
public static native void getAllJoystickData(
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/java/edu/wpi/first/hal/REVPHJNI.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class REVPHJNI extends JNIWrapper {
*
* @param module the CAN ID to initialize
* @return the created PH handle
* @see "HAL_InitializeREVP"
* @see "HAL_InitializeREVPH"
*/
public static native int initialize(int module);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
package edu.wpi.first.hal.util;

/**
* Exception indicating that the resource is already allocated This is meant to be thrown by the
* Exception indicating that the resource is already allocated. This is meant to be thrown by the
* resource class.
*/
public class CheckedAllocationException extends Exception {
Expand Down
6 changes: 3 additions & 3 deletions hal/src/main/native/athena/DMA.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,8 @@ void HAL_SetDMAPause(HAL_DMAHandle handle, HAL_Bool pause, int32_t* status) {

void HAL_SetDMATimedTrigger(HAL_DMAHandle handle, double seconds,
int32_t* status) {
constexpr double baseMultipler = kSystemClockTicksPerMicrosecond * 1000000;
uint32_t cycles = static_cast<uint32_t>(baseMultipler * seconds);
constexpr double baseMultiplier = kSystemClockTicksPerMicrosecond * 1000000;
uint32_t cycles = static_cast<uint32_t>(baseMultiplier * seconds);
HAL_SetDMATimedTriggerCycles(handle, cycles, status);
}

Expand Down Expand Up @@ -564,7 +564,7 @@ int32_t HAL_SetDMAExternalTrigger(HAL_DMAHandle handle,
if (!success) {
*status = PARAMETER_OUT_OF_RANGE;
hal::SetLastError(status,
"Digital Source unabled to be mapped properly. Likely "
"Digital Source unable to be mapped properly. Likely "
"invalid handle passed.");
return 0;
}
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/native/athena/DigitalInternal.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ namespace detail {
wpi::mutex& UnsafeGetDIOMutex() {
return digitalDIOMutex;
}
tDIO* UnsafeGetDigialSystem() {
tDIO* UnsafeGetDigitalSystem() {
return digitalSystem.get();
}
int32_t ComputeDigitalMask(HAL_DigitalHandle handle, int32_t* status) {
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/native/athena/HAL.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -479,7 +479,7 @@ HAL_Bool HAL_GetSystemTimeValid(int32_t* status) {
static bool killExistingProgram(int timeout, int mode) {
// Kill any previous robot programs
std::fstream fs;
// By making this both in/out, it won't give us an error if it doesnt exist
// By making this both in/out, it won't give us an error if it doesn't exist
fs.open("/var/lock/frc.pid", std::fstream::in | std::fstream::out);
if (fs.bad()) {
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ DEFINE_CAPI(double, X, 0)
DEFINE_CAPI(double, Y, 0)
DEFINE_CAPI(double, Z, 0)

void HALSIM_RegisterSPIAccelerometerAllCallbcaks(int32_t index,
void HALSIM_RegisterSPIAccelerometerAllCallbacks(int32_t index,
HAL_NotifyCallback callback,
void* param,
HAL_Bool initialNotify) {}
Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/native/include/hal/AnalogGyro.h
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ double HAL_GetAnalogGyroRate(HAL_GyroHandle handle, int32_t* status);
*
* @param[in] handle the gyro handle
* @param[out] status Error status variable. 0 on success.
* @return the gryo offset
* @return the gyro offset
*/
double HAL_GetAnalogGyroOffset(HAL_GyroHandle handle, int32_t* status);

Expand Down
2 changes: 1 addition & 1 deletion hal/src/main/native/include/hal/AnalogTrigger.h
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ HAL_Bool HAL_GetAnalogTriggerOutput(HAL_AnalogTriggerHandle analogTriggerHandle,
int32_t* status);

/**
* Get the FPGA index for the AnlogTrigger.
* Get the FPGA index for the AnalogTrigger.
*
* @param[in] analogTriggerHandle the trigger handle
* @param[out] status Error status variable. 0 on success.
Expand Down
4 changes: 2 additions & 2 deletions hal/src/main/native/include/hal/cpp/UnsafeDIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ struct DIOSetProxy {
};
namespace detail {
wpi::mutex& UnsafeGetDIOMutex();
tDIO* UnsafeGetDigialSystem();
tDIO* UnsafeGetDigitalSystem();
int32_t ComputeDigitalMask(HAL_DigitalHandle handle, int32_t* status);
} // namespace detail

Expand All @@ -81,7 +81,7 @@ void UnsafeManipulateDIO(HAL_DigitalHandle handle, int32_t* status,
return;
}
wpi::mutex& dioMutex = detail::UnsafeGetDIOMutex();
tDIO* dSys = detail::UnsafeGetDigialSystem();
tDIO* dSys = detail::UnsafeGetDigitalSystem();
auto mask = detail::ComputeDigitalMask(handle, status);
if (*status != 0) {
return;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ void HALSIM_CancelSPIAccelerometerZCallback(int32_t index, int32_t uid);
double HALSIM_GetSPIAccelerometerZ(int32_t index);
void HALSIM_SetSPIAccelerometerZ(int32_t index, double z);

void HALSIM_RegisterSPIAccelerometerAllCallbcaks(int32_t index,
void HALSIM_RegisterSPIAccelerometerAllCallbacks(int32_t index,
HAL_NotifyCallback callback,
void* param,
HAL_Bool initialNotify);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ DEFINE_CAPI(double, Z, z)
SimSPIAccelerometerData[index].NAME.RegisterCallback(callback, param, \
initialNotify)

void HALSIM_RegisterSPIAccelerometerAllCallbcaks(int32_t index,
void HALSIM_RegisterSPIAccelerometerAllCallbacks(int32_t index,
HAL_NotifyCallback callback,
void* param,
HAL_Bool initialNotify) {
Expand Down
2 changes: 1 addition & 1 deletion ntcore/doc/networktables4.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A pub/sub WebSockets protocol based on NetworkTables concepts.

While NetworkTables 4.0 made a large number of improvements to the 3.0 protocol, a few weaknesses have been discovered in "real world" use:

* Keep alives are not required. This can result in very long timeframes before a disconnect is detected.
* Keepalives are not required. This can result in very long timeframes before a disconnect is detected.
* Periodic synchronization of timestamps is impacted by high variability of round trip time measurements on a stream connection shared with other data (due to network queueing in adverse network connections), resulting in values being "too old" even if actually more recent due to a change in base time
* Disconnect loops can be caused by large amounts of data values being sent in response to a "subscribe all" type of message (e.g. subscribe with empty or `$` prefix), resulting in data transmission being blocked for an excessive amount of time
* Publishing operations are not clearly subscriber-driven; the information is available via metatopics but not automatically sent to clients when clients publish
Expand Down
4 changes: 2 additions & 2 deletions ntcore/src/generate/main/java/NetworkTablesJNI.java.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ public final class NetworkTablesJNI {
public static native void releaseEntry(int entry);

/**
* Relesaes pubsub entry.
* Releases pubsub entry.
*
* @param pubsubentry Pubsub entry handle.
*/
Expand Down Expand Up @@ -1002,7 +1002,7 @@ public final class NetworkTablesJNI {
/**
* Returns the current timestamp in microseconds.
*
* @return The current timestsamp in microseconds.
* @return The current timestamp in microseconds.
*/
public static native long now();

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions ntcore/src/test/native/cpp/LocalStorageTest.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ TEST_F(LocalStorageNumberVariantsTest, GetEntryPubAfter) {
EXPECT_EQ(storage.GetEntryValue(sub2), Value::MakeInteger(1, 50));
EXPECT_EQ(storage.GetEntryValue(sub3), Value::MakeFloat(1.0, 50));
EXPECT_EQ(storage.GetEntryValue(sub4), Value{});
// entrys just get whatever the value is
// entries just get whatever the value is
EXPECT_EQ(storage.GetEntryValue(entry), Value::MakeDouble(1.0, 50));
}

Expand All @@ -781,7 +781,7 @@ TEST_F(LocalStorageNumberVariantsTest, GetEntryPubBefore) {
EXPECT_EQ(storage.GetEntryValue(sub2), Value::MakeInteger(1, 50));
EXPECT_EQ(storage.GetEntryValue(sub3), Value::MakeFloat(1.0, 50));
EXPECT_EQ(storage.GetEntryValue(sub4), Value{});
// entrys just get whatever the value is
// entries just get whatever the value is
EXPECT_EQ(storage.GetEntryValue(entry), Value::MakeDouble(1.0, 50));
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ class AnalysisManager {
std::string_view GetUnit() const { return m_data.distanceUnit; }

/**
* Returns a reference to the iterator of the currently selected raw datset.
* Returns a reference to the iterator of the currently selected raw dataset.
* Unfortunately, due to ImPlot internals, the reference cannot be const so
* the user should be careful not to change any data.
*
Expand All @@ -264,7 +264,7 @@ class AnalysisManager {

/**
* Returns a reference to the iterator of the currently selected filtered
* datset. Unfortunately, due to ImPlot internals, the reference cannot be
* dataset. Unfortunately, due to ImPlot internals, the reference cannot be
* const so the user should be careful not to change any data.
*
* @return A reference to the filtered internal data.
Expand Down
2 changes: 1 addition & 1 deletion sysid/src/main/native/include/sysid/analysis/OLS.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace sysid {

struct OLSResult {
/// Regression coeficients.
/// Regression coefficients.
std::vector<double> coeffs;

/// R² (coefficient of determination)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ public ParallelDeadlineGroup deadlineWith(Command... parallel) {
* commands with {@link CommandScheduler#removeComposedCommand(Command)}. The command composition
* returned from this method can be further decorated without issue.
*
* @param parallel the commands to run in parallel. Note the parallel commands will be interupted
* @param parallel the commands to run in parallel. Note the parallel commands will be interrupted
* when the deadline command ends
* @return the decorated command
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ public static Command defer(Supplier<Command> supplier, Set<Subsystem> requireme
* @param supplier the command supplier
* @return the command
* @deprecated The ProxyCommand supplier constructor has been deprecated in favor of directly
* proxying a {@link DeferredCommand}, see ProxyCommand documentaion for more details. As a
* proxying a {@link DeferredCommand}, see ProxyCommand documentation for more details. As a
* replacement, consider using `defer(supplier).asProxy()`.
* @see ProxyCommand
*/
Expand Down
4 changes: 2 additions & 2 deletions wpilibc/src/main/native/cpp/PneumaticHub.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ void PneumaticHub::EnableCompressorAnalog(
units::pounds_per_square_inch_t maxPressure) {
if (minPressure >= maxPressure) {
throw FRC_MakeError(err::InvalidParameter,
"maxPressure must be greater than minPresure");
"maxPressure must be greater than minPressure");
}
if (minPressure < 0_psi || minPressure > 120_psi) {
throw FRC_MakeError(err::ParameterOutOfRange,
Expand Down Expand Up @@ -178,7 +178,7 @@ void PneumaticHub::EnableCompressorHybrid(
units::pounds_per_square_inch_t maxPressure) {
if (minPressure >= maxPressure) {
throw FRC_MakeError(err::InvalidParameter,
"maxPressure must be greater than minPresure");
"maxPressure must be greater than minPressure");
}
if (minPressure < 0_psi || minPressure > 120_psi) {
throw FRC_MakeError(err::ParameterOutOfRange,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class AnalogTrigger;
* / down counter or to interrupts. Because the outputs generate a pulse, they
* cannot be read directly. To help ensure that a rollover condition is not
* missed, there is an average rejection filter available that operates on the
* upper 8 bits of a 12 bit number and selects the nearest outlyer of 3 samples.
* upper 8 bits of a 12 bit number and selects the nearest outlier of 3 samples.
* This will reject a sample that is (due to averaging or sampling) errantly
* between the two limits. This filter will fail if more than one sample in a
* row is errantly in between the two limits. You may see this problem if
Expand Down
6 changes: 3 additions & 3 deletions wpilibc/src/main/native/include/frc/Counter.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ class Counter : public CounterBase,
/**
* Create an instance of a counter where no sources are selected.
*
* They all must be selected by calling functions to specify the upsource and
* the downsource independently.
* They all must be selected by calling functions to specify the up source and
* the down source independently.
*
* This creates a ChipObject counter and initializes status variables
* appropriately.
Expand Down Expand Up @@ -148,7 +148,7 @@ class Counter : public CounterBase,
Counter& operator=(Counter&&) = default;

/**
* Set the upsource for the counter as a digital input channel.
* Set the up source for the counter as a digital input channel.
*
* @param channel The DIO channel to use as the up source. 0-9 are on-board,
* 10-25 are on the MXP
Expand Down
2 changes: 1 addition & 1 deletion wpilibc/src/main/native/include/frc/SerialPort.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class SerialPort {
kOnboard = 0,
/// MXP (roboRIO MXP) serial port.
kMXP = 1,
/// USB serial port (same as KUSB1).
/// USB serial port (same as kUSB1).
kUSB = 2,
/// USB serial port 1.
kUSB1 = 2,
Expand Down
Loading
Loading