Skip to content

Commit a5c7580

Browse files
committed
Grammar Police the arg descriptions
1 parent 6d127b4 commit a5c7580

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

src/main.rs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ fn get_setup(args: &[String]) -> Setup {
248248
).optopt(
249249
"",
250250
SYSTEM_CACHE,
251-
"Path to a directory where system files (credentials, volume) will be cached. Can be different from cache option value.",
251+
"Path to a directory where system files (credentials, volume) will be cached. May be different from the cache option value.",
252252
"PATH",
253253
).optopt(
254254
"",
@@ -257,7 +257,7 @@ fn get_setup(args: &[String]) -> Setup {
257257
"SIZE"
258258
).optflag("", DISABLE_AUDIO_CACHE, "Disable caching of the audio data.")
259259
.optopt("n", NAME, "Device name.", "NAME")
260-
.optopt("", DEVICE_TYPE, "Displayed device type.", "TYPE")
260+
.optopt("", DEVICE_TYPE, "Displayed device type. Defaults to 'Speaker'.", "TYPE")
261261
.optopt(
262262
BITRATE,
263263
"bitrate",
@@ -270,14 +270,14 @@ fn get_setup(args: &[String]) -> Setup {
270270
"Run PROGRAM when a playback event occurs.",
271271
"PROGRAM",
272272
)
273-
.optflag("", EMIT_SINK_EVENTS, "Run program set by --onevent before sink is opened and after it is closed.")
273+
.optflag("", EMIT_SINK_EVENTS, "Run PROGRAM set by --onevent before sink is opened and after it is closed.")
274274
.optflag("v", VERBOSE, "Enable verbose output.")
275275
.optflag("V", VERSION, "Display librespot version string.")
276-
.optopt("u", USERNAME, "Username to sign in with.", "USERNAME")
277-
.optopt("p", PASSWORD, "Password", "PASSWORD")
276+
.optopt("u", USERNAME, "Username used to sign in with.", "USERNAME")
277+
.optopt("p", PASSWORD, "Password used to sign in with.", "PASSWORD")
278278
.optopt("", PROXY, "HTTP proxy to use when connecting.", "URL")
279-
.optopt("", AP_PORT, "Connect to AP with specified port. If no AP with that port are present fallback AP will be used. Available ports are usually 80, 443 and 4070.", "PORT")
280-
.optflag("", DISABLE_DISCOVERY, "Disable discovery mode.")
279+
.optopt("", AP_PORT, "Connect to an AP with a specified port. If no AP with that port is present a fallback AP will be used. Available ports are usually 80, 443 and 4070.", "PORT")
280+
.optflag("", DISABLE_DISCOVERY, "Disable zeroconf discovery mode.")
281281
.optopt(
282282
"",
283283
BACKEND,
@@ -287,7 +287,7 @@ fn get_setup(args: &[String]) -> Setup {
287287
.optopt(
288288
"",
289289
DEVICE,
290-
"Audio device to use. Use '?' to list options if using alsa, portaudio or rodio.",
290+
"Audio device to use. Use '?' to list options if using alsa, portaudio or rodio. Defaults to the backend's default.",
291291
"NAME",
292292
)
293293
.optopt(
@@ -299,10 +299,10 @@ fn get_setup(args: &[String]) -> Setup {
299299
.optopt(
300300
"",
301301
DITHER,
302-
"Specify the dither algorithm to use - [none, gpdf, tpdf, tpdf_hp]. Defaults to 'tpdf' for formats S16, S24, S24_3 and 'none' for other formats.",
302+
"Specify the dither algorithm to use {none|gpdf|tpdf|tpdf_hp}. Defaults to 'tpdf' for formats S16, S24, S24_3 and 'none' for other formats.",
303303
"DITHER",
304304
)
305-
.optopt("m", MIXER_TYPE, "Mixer to use {alsa|softvol}.", "MIXER")
305+
.optopt("m", MIXER_TYPE, "Mixer to use {alsa|softvol}. Defaults to softvol", "MIXER")
306306
.optopt(
307307
"",
308308
"mixer-name", // deprecated
@@ -312,7 +312,7 @@ fn get_setup(args: &[String]) -> Setup {
312312
.optopt(
313313
"",
314314
ALSA_MIXER_CONTROL,
315-
"Alsa mixer control, e.g. 'PCM' or 'Master'. Defaults to 'PCM'.",
315+
"Alsa mixer control, e.g. 'PCM', 'Master' or similar. Defaults to 'PCM'.",
316316
"NAME",
317317
)
318318
.optopt(
@@ -348,13 +348,13 @@ fn get_setup(args: &[String]) -> Setup {
348348
.optopt(
349349
"",
350350
ZEROCONF_PORT,
351-
"The port the internal server advertised over zeroconf uses.",
351+
"The port the internal server advertises over zeroconf.",
352352
"PORT",
353353
)
354354
.optflag(
355355
"",
356356
ENABLE_VOLUME_NORMALISATION,
357-
"Play all tracks at the same volume.",
357+
"Play all tracks at approximately the same apparent volume.",
358358
)
359359
.optopt(
360360
"",
@@ -377,19 +377,19 @@ fn get_setup(args: &[String]) -> Setup {
377377
.optopt(
378378
"",
379379
NORMALISATION_THRESHOLD,
380-
"Threshold (dBFS) to prevent clipping. Defaults to -2.0.",
380+
"Threshold (dBFS) at which the dynamic limiter engages to prevent clipping. Defaults to -2.0.",
381381
"THRESHOLD",
382382
)
383383
.optopt(
384384
"",
385385
NORMALISATION_ATTACK,
386-
"Attack time (ms) in which the dynamic limiter is reducing gain. Defaults to 5.",
386+
"Attack time (ms) in which the dynamic limiter reduces gain. Defaults to 5.",
387387
"TIME",
388388
)
389389
.optopt(
390390
"",
391391
NORMALISATION_RELEASE,
392-
"Release or decay time (ms) in which the dynamic limiter is restoring gain. Defaults to 100.",
392+
"Release or decay time (ms) in which the dynamic limiter restores gain. Defaults to 100.",
393393
"TIME",
394394
)
395395
.optopt(
@@ -401,7 +401,7 @@ fn get_setup(args: &[String]) -> Setup {
401401
.optopt(
402402
"",
403403
VOLUME_CTRL,
404-
"Volume control type {cubic|fixed|linear|log}. Defaults to log.",
404+
"Volume control scale type {cubic|fixed|linear|log}. Defaults to log.",
405405
"VOLUME_CTRL"
406406
)
407407
.optopt(
@@ -423,7 +423,7 @@ fn get_setup(args: &[String]) -> Setup {
423423
.optflag(
424424
"",
425425
PASSTHROUGH,
426-
"Pass raw stream to output, only works for pipe and subprocess.",
426+
"Pass a raw stream to the output. Only works with the pipe and subprocess backends.",
427427
);
428428

429429
let matches = match opts.parse(&args[1..]) {

0 commit comments

Comments
 (0)