Skip to content

Commit

Permalink
Amend example documnetation
Browse files Browse the repository at this point in the history
  • Loading branch information
justinkaseman committed Dec 12, 2024
1 parent 87a0298 commit 53bd064
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions pkg/codec/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ func (h *HardCodeModifierConfig) MarshalJSON() ([]byte, error) {
// And the fields config defined as:
// {"A": "string C, string D"}
//
// The codec factory function returns a RemoteCodec that provides an implementation for encoding/decoding
// The codec config gives a map of strings (the values from fields config map) to implementation for encoding/decoding
//
// RemoteCodec {
// func (types.TypeProvider) CreateType(itemType string, forEncoding bool) (any, error)
Expand All @@ -233,9 +233,7 @@ func (h *HardCodeModifierConfig) MarshalJSON() ([]byte, error) {
// func (types.Encoder) GetMaxEncodingSize(ctx context.Context, n int, itemType string) (int, error)
// }
//
// func (typeDef string) RemoteCodec {
// return someCodec.New(typeDef)
// }
// {"string C, string D": RemoteCodec}
//
// Result:
// type example struct {
Expand Down

0 comments on commit 53bd064

Please sign in to comment.