Skip to content

Commit 6c0be77

Browse files
committed
fix: reword description
1 parent 849a03e commit 6c0be77

5 files changed

Lines changed: 11 additions & 11 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ exclude = ["/README.md"]
88
keywords = ["cli", "formatter"]
99
license = "MIT"
1010
repository = "https://github.com/azzamsa/gelatyx"
11-
description = "Format codebease inside the docs"
11+
description = "Format code blocks inside the docs"
1212

1313
[profile.release]
1414
opt-level = 'z' # Optimize for size.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<img src='docs/bird.svg' width=80px />
55

6-
Format codebase in documentation.
6+
Format code blocks inside documentation files.
77

88
<a href="https://github.com/azzamsa/gelatyx/workflows/ci.yml">
99
<img src="https://github.com/azzamsa/gelatyx/workflows/ci/badge.svg" alt="Build status" />
@@ -31,7 +31,7 @@ Format codebase in documentation.
3131

3232
## Features
3333

34-
- Format language code block inside documentation files.
34+
- Format language code blocks inside documentation files.
3535
- Check mode. Ask Gelatyx if the documentation has been formatted.
3636
- Glob support.
3737
- Configure the formatter via a configuration file.

docs/dev/demo.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
#doitlive shell: /bin/zsh
33
#doitlive speed: 3
44

5-
# doc.md: contains valid unformatted code-block
6-
# doc1.md: contains invalid unformatted code-block
7-
# doc2.md: contains valid formatted code-block
5+
# doc.md: contains valid unformatted code blocks
6+
# doc1.md: contains invalid unformatted code blocks
7+
# doc2.md: contains valid formatted code blocks
88
gelatyx --language lua doc.md doc1.md doc2.md --check
99
clear
1010

src/cli.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use clap::{Parser, ValueEnum};
66
#[command(
77
name = "gelatyx",
88
version,
9-
about = "Gelatyx 🦤. \nFormat codebease inside the docs",
9+
about = "Gelatyx 🦤. \nFormat code blocks inside the docs",
1010
after_long_help = "Bugs can be reported on GitHub: https://github.com/azzamsa/gelatyx/issues"
1111
)]
1212
pub struct Opts {
@@ -17,7 +17,7 @@ pub struct Opts {
1717
#[arg(long, conflicts_with("file"))]
1818
pub file_list: Option<PathBuf>,
1919

20-
/// Language used in code block
20+
/// Language used in code blocks
2121
#[arg(short, long, value_enum)]
2222
pub language: Language,
2323

tests/integration.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ use predicates::prelude::*;
88
fn help() -> Result<(), Box<dyn Error>> {
99
let mut cmd = Command::cargo_bin(crate_name!())?;
1010
cmd.arg("-h");
11-
cmd.assert()
12-
.success()
13-
.stdout(predicate::str::contains("Format codebease inside the docs"));
11+
cmd.assert().success().stdout(predicate::str::contains(
12+
"Format code blocks inside the docs",
13+
));
1414

1515
Ok(())
1616
}

0 commit comments

Comments
 (0)