Skip to content

Commit

Permalink
Fix typo.
Browse files Browse the repository at this point in the history
  • Loading branch information
grahammiln authored Oct 25, 2024
1 parent a83f479 commit 51e576d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ And MkUnion use it heavily to offer way of adding new behaviour to go types.
##### Tags supported by MkUnion

- `go:tag mkunion:"Vehicle"` - define union type
- `go:tag serde:"json"` - enable serialisation type (currently only JSON is supported), enbabled by default
- `go:tag serde:"json"` - enable serialisation type (currently only JSON is supported), enabled by default
- `go:tag shape:"-"` - disable shape generation for this type, useful in cases x/shared package cannot depend on other x packages, to avid circular dependencies
- `go:tag mkunion:",no-type-registry"` - if you want to disable generation type registry in a package, in one of go files above package declaration define tag
```go
Expand Down Expand Up @@ -158,4 +158,4 @@ func ExampleVehicleToJSON() {
You can notice that it has opinionated way of marshalling and unmarshalling your union type.
It uses `$type` field to store type information, and then store actual data in separate field, with corresponding name.

You can read more about it in [Marshaling union in JSON](./examples/json.md) section.
You can read more about it in [Marshaling union in JSON](./examples/json.md) section.

0 comments on commit 51e576d

Please sign in to comment.