Skip to content

Commit c26521e

Browse files
authored
Improve cli docstring (#240)
1 parent fe6c4ca commit c26521e

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ cargo install prql
5151
### Usage
5252

5353
```sh
54-
echo "from employees | filter has_dog" | prql compile
54+
$ echo "from employees | filter has_dog" | prql compile
55+
5556
SELECT
5657
*
5758
FROM
@@ -60,7 +61,7 @@ WHERE
6061
has_dog
6162
```
6263

63-
More details in `prql compile --help`. See below for better examples of PRQL.
64+
See below for fuller examples of PRQL.
6465

6566
### Python implementation
6667

src/cli.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ enum Dialect {
1212
}
1313

1414
#[derive(Parser)]
15-
#[clap(name = env!("CARGO_PKG_NAME"), about, version, author)]
15+
#[clap(name = env!("CARGO_PKG_NAME"), about, version)]
1616
pub enum Cli {
1717
Compile(CompileCommand),
1818
}
1919

2020
#[derive(Args)]
21-
#[clap()]
21+
/// Compile a PRQL string into a SQL string.
22+
///
23+
/// See https://github.com/max-sixty/prql for more information.
2224
pub struct CompileCommand {
2325
#[clap(default_value="-", parse(try_from_os_str = Input::try_from))]
2426
input: Input,

0 commit comments

Comments
 (0)