From e94794fd37dde310ff622170d9e1329ae14b29f2 Mon Sep 17 00:00:00 2001 From: Felix Lange Date: Mon, 27 Feb 2017 16:41:46 +0100 Subject: [PATCH] fix documentation typos --- README.md | 6 +++--- main.go | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 09b7dc5..7843374 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ features which the standard json package cannot offer. ### Struct Tags All fields are required unless the "optional" struct tag is present. The generated -unmarshaling method return an error if a required field is missing. Other struct tags are +unmarshaling method returns an error if a required field is missing. Other struct tags are carried over as is. The standard "json" and "yaml" tags can be used to rename a field when -marshaling to/from JSON. +marshaling. Example: - type foo { + type foo struct { Required string Optional string `optional:""` Renamed string `json:"otherName"` diff --git a/main.go b/main.go index ca98921..9fb0da7 100644 --- a/main.go +++ b/main.go @@ -14,13 +14,13 @@ features which the standard json package cannot offer. Struct Tags All fields are required unless the "optional" struct tag is present. The generated -unmarshaling method return an error if a required field is missing. Other struct tags are +unmarshaling method returns an error if a required field is missing. Other struct tags are carried over as is. The standard "json" and "yaml" tags can be used to rename a field when -marshaling to/from JSON. +marshaling. Example: - type foo { + type foo struct { Required string Optional string `optional:""` Renamed string `json:"otherName"`