Skip to content

Commit 791cf38

Browse files
committed
Improves the documentation
1 parent 40de0c6 commit 791cf38

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ The `init` command will create an initial `.lpv` file with the default patterns
227227
lean-package-validator init [<directory>]
228228
```
229229

230-
The `--overwrite|-o` option overwrites an existing `.lpv` file.
230+
The `--overwrite|-o` option overwrites an existing `.lpv` file. Also see the [refresh](#refresh-command) command.
231231

232232
The `--preset` option allows choosing from a predefined set of glob pattern. Available presets are `PHP`, `Python`, `Rust`,
233233
`JavaScript`, and `Go`. With `PHP` being the default.
@@ -243,7 +243,7 @@ modifications already present in the file.
243243
lean-package-validator refresh [<directory>]
244244
```
245245

246-
The command expects a present `.lpv` file in the target directory and will fail if none existent.
246+
The command expects a present `.lpv` file in the target directory and will fail if none is existent.
247247

248248
The `--preset` option allows choosing from a predefined set of glob pattern. Available presets are `PHP`, `Python`, `Rust`,
249249
`JavaScript`, and `Go`. With `PHP` being the default.
@@ -332,9 +332,9 @@ For utilising a dedicated GitHub Action have a look at the documentation over [h
332332
### Included AI skills
333333

334334
This project [includes](./resources/boost/skills) three AI skills focused on managing the `.gitattributes` file for a package:
335-
- validating: check whether the current `.gitattributes` content matches the expected export-ignore rules.
336-
- creating: generate a `.gitattributes` file when it is missing.
337-
- updating: reconcile an existing `.gitattributes` file with expected export-ignore rules.
335+
- __validate__: check whether the current `.gitattributes` content matches the expected export-ignore rules.
336+
- __create__: generate a `.gitattributes` file when it is missing.
337+
- __update__: reconcile an existing `.gitattributes` file with expected export-ignore rules.
338338

339339
### Running tests
340340

0 commit comments

Comments
 (0)