Skip to content

Commit 0dbec58

Browse files
authored
Merge pull request #75 from mpkocher/fix-readme
Fix README with correct quickstart section
2 parents f4019b4 + 5cc20af commit 0dbec58

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ my-tool --input_file /path/to/file.txt --max_records 1234
4747

4848
This requires two components.
4949

50-
- Create Pydantic Data Model of type `T`
51-
- write a function that takes an instance of `T` and returns the exit code (e.g., 0 for success, non-zero for failure).
52-
- pass the `T` into to the `to_runner` function, or the `run_and_exit`
50+
- Create Pydantic Data Model `T` by extending `Cmd`
51+
- Add a method `def run(self) -> None`. This should raise an exception on error, or return `None` on success.
52+
- pass the *class* `T` into to the `to_runner` function, or the `run_and_exit`
5353

5454
Explicit example show below.
5555

0 commit comments

Comments
 (0)