Skip to content

Commit 40028d2

Browse files
committed
docs: fix spelling & typo
Signed-off-by: David Bernard <[email protected]>
1 parent a4f2d7a commit 40028d2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

generator/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ Goals: generate rust code for cdevents from jsonschema provided as part of cdeve
44

55
- The generator take read jsonschema as json apply them to a set of templates
66
- The generator is very basic (no json schema semantic, no `$ref` resolution) like [eventuallyconsultant/codegenr: Fast handlebars templates based code generator, ingesting swagger/openapi and other json/yaml documents with $refs, or graphql schema, outputs whatever you template](https://github.com/eventuallyconsultant/codegenr/)
7-
- The generator is currently used to generated Subjects
7+
- The generator is currently used to generate Subjects
88

99
## Why not use a jsonschema to rust generator?
1010

11-
- I tried some and they failed (no error), maybe too early, not support for the version of jsonschema used by cdevents (often they support jsonschema draft-4)
12-
- The json schema (v0.3) are not connected, so lot of duplication (context,...), so classical generators will create as many Context type as Event type,... Our implementation only part of the schema is extracted to generate what is different aka the `content` of subjects.
11+
- I tried some and they failed (no error), maybe too early, or do not support the version of jsonschema used by cdevents (often they support jsonschema draft-4)
12+
- The jsonschemas (v0.3) are not connected (a set of independent schemas), so a lot of duplication (context,...), so classical generators will create as many Context types as Event types,... In our implementation, only parts of the schema are extracted to generate what is different aka the `content` of subjects.
1313

1414
## Run
1515

16-
To generate the `subjects` into sibling crate `cdevents/src/generated` from content of `cdevents-specs/spec-v0.4/schemas`, from root workspace
16+
To generate the `subjects` into sibling crate `cdevents/src/generated` from the content of `cdevents-specs/spec-v0.4/schemas`, from the root workspace
1717

1818
```sh
1919
cargo run -p generator -- --help

0 commit comments

Comments
 (0)