Skip to content

Commit

Permalink
apps: Remove periods from descriptions
Browse files Browse the repository at this point in the history
Aligns our custom descriptions with the one for the --help option.
  • Loading branch information
StollD committed Apr 25, 2024
1 parent 0a53d1c commit 871bc4f
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions src/apps/calibrate/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for measuring your finger size and calibrating iptsd."};
CLI::App app {"Utility for measuring your finger size and calibrating iptsd"};

std::filesystem::path path {};
app.add_option("DEVICE", path)
->description("The hidraw device node of the touchscreen.")
->description("The hidraw device node of the touchscreen")
->type_name("FILE")
->required();

Expand Down
8 changes: 4 additions & 4 deletions src/apps/check-device/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for checking if a hidraw device is an IPTS touch device."};
CLI::App app {"Utility for checking if a hidraw device is an IPTS touch device"};

std::filesystem::path path {};
app.add_option("DEVICE", path)
->description("The hidraw device node to check.")
->description("The hidraw device node to check")
->type_name("FILE")
->required();

bool quiet = false;
app.add_flag("-q,--quiet", quiet)->description("Disable output of device information.");
app.add_flag("-q,--quiet", quiet)->description("Disable output of device information");

const std::set<std::string> allowed_types {"any", "touchscreen", "touchpad"};
const std::map<std::string, std::optional<ipts::Device::Type>> type_map = {
Expand All @@ -43,7 +43,7 @@ int run(const int argc, const char **argv)

std::string type = "any";
app.add_option("-t,--type", type)
->description("Whether to look for a specific type of device.")
->description("Whether to look for a specific type of device")
->transform(CLI::IsMember(allowed_types));

app.get_formatter()->column_width(45);
Expand Down
4 changes: 2 additions & 2 deletions src/apps/daemon/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Daemon to translate touchscreen inputs to Linux input events."};
CLI::App app {"Daemon to translate touchscreen inputs to Linux input events"};

std::filesystem::path path {};
app.add_option("DEVICE", path)
->description("The hidraw device node of the touchscreen.")
->description("The hidraw device node of the touchscreen")
->type_name("FILE")
->required();

Expand Down
4 changes: 2 additions & 2 deletions src/apps/dump/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for saving raw reports from your touchscreen to a binary file."};
CLI::App app {"Utility for saving raw reports from your touchscreen to a binary file"};

std::filesystem::path path {};
app.add_option("DEVICE", path)
->description("The hidraw device node of the touchscreen.")
->description("The hidraw device node of the touchscreen")
->type_name("FILE")
->required();

Expand Down
6 changes: 3 additions & 3 deletions src/apps/perf/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,17 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for performance testing of iptsd."};
CLI::App app {"Utility for performance testing of iptsd"};

std::filesystem::path path {};
app.add_option("DATA", path)
->description("A binary data file containing touch reports.")
->description("A binary data file containing touch reports")
->type_name("FILE")
->required();

usize runs {};
app.add_option("RUNS", runs)
->description("How many times data will be processed.")
->description("How many times data will be processed")
->check(CLI::PositiveNumber)
->default_val(10);

Expand Down
6 changes: 3 additions & 3 deletions src/apps/visualization/plot.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for rendering captured touchscreen inputs to PNG frames."};
CLI::App app {"Utility for rendering captured touchscreen inputs to PNG frames"};

std::filesystem::path path {};
app.add_option("DATA", path)
->description("A binary data file containing touch reports.")
->description("A binary data file containing touch reports")
->type_name("FILE")
->required();

std::filesystem::path output {};
app.add_option("OUTPUT", output)
->description("The directory where the rendered frames are saved.")
->description("The directory where the rendered frames are saved")
->type_name("DIR")
->required();

Expand Down
4 changes: 2 additions & 2 deletions src/apps/visualization/show.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ namespace {

int run(const int argc, const char **argv)
{
CLI::App app {"Utility for rendering touchscreen inputs in real time."};
CLI::App app {"Utility for rendering touchscreen inputs in real time"};

std::filesystem::path path {};
app.add_option("DEVICE", path)
->description("The hidraw device node of the touchscreen.")
->description("The hidraw device node of the touchscreen")
->type_name("FILE")
->required();

Expand Down

0 comments on commit 871bc4f

Please sign in to comment.