Skip to content

Commit bca5106

Browse files
authored
Format markdown documentation (#22)
* Format markdown documentation * Fix doc typos * Apply feedback to docs * Address PR comments * Fix style issues * Split CLI imports onto separate lines * Fix CLI snippet and hyphenation
1 parent 1a437c6 commit bca5106

File tree

6 files changed

+541
-519
lines changed

6 files changed

+541
-519
lines changed

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
- **Clarity over cleverness.** Be concise, but favour explicit over terse or
1010
obscure idioms. Prefer code that's easy to follow.
1111
- **Use functions and composition.** Avoid repetition by extracting reusable
12-
logic. Prefer generators or comprehensions, and declarative code to imperative
13-
repetition when readable.
12+
logic. Prefer generators or comprehensions, and declarative code to
13+
imperative repetition when readable.
1414
- **Small, meaningful functions.** Functions must be small, clear in purpose,
1515
single responsibility, and obey command/query segregation.
1616
- **Clear commit messages.** Commit messages should be descriptive, explaining
@@ -95,8 +95,8 @@
9595
## Rust Specific Guidance
9696

9797
This repository is written in Rust and uses Cargo for building and dependency
98-
management. Contributors should follow these best practices when working on
99-
the project:
98+
management. Contributors should follow these best practices when working on the
99+
project:
100100

101101
- Run `make fmt`, `make lint`, and `make test` before committing. These targets
102102
wrap `cargo fmt`, `cargo clippy`, and `cargo test` with the appropriate flags.

docs/behavioural-testing-in-rust-with-cucumber.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -933,13 +933,13 @@ variant is far more valuable for debugging than a stack trace from a panic.[^20]
933933
**Pitfall:** The test run fails with an "ambiguous step" error. This means a
934934
single Gherkin step matches the patterns of two or more Rust functions.[^21]
935935

936-
**Solution:** <!-- markdownlint-disable MD029 -->
936+
**Solution:**
937937

938-
5. **Be More Specific:** Make the Gherkin step text or the matching pattern more
939-
precise to eliminate the ambiguity.
938+
1. **Be More Specific:** Make the Gherkin step text or the matching pattern
939+
more precise to eliminate the ambiguity.
940940

941-
6. **Anchor Regex:** When using regular expressions, always anchor them with `^`
942-
at the start and `$` at the end (e.g., <!-- markdownlint-enable MD029 -->
941+
2. **Anchor Regex:** When using regular expressions, always anchor them with
942+
`^` at the start and `$` at the end (e.g.,
943943
`regex = r"^the user is logged in$"`). This prevents a step like
944944
`"the admin user is logged in"` from accidentally matching a less specific
945945
pattern like `regex = r"user is logged in"`.[^18]

0 commit comments

Comments
 (0)