Skip to content

Commit

Permalink
Fixup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
liggitt committed Oct 20, 2021
1 parent 52af206 commit cd512f1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Any code that is added must:
* Be backward compatible with the existing exposed go API
* Have zero external dependencies
* Preserve existing benchmark performance
* Preserve compatibility with existing decoding behavior of `Unmarshal()` or `UnmarshalStrict()`
* Preserve compatibility with existing decoding behavior of `UnmarshalCaseSensitivePreserveInts()` or `UnmarshalStrict()`
* Avoid use of `unsafe`

## Getting Started
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ It provides case-sensitive, integer-preserving JSON unmarshaling functions based

## Compatibility

The `Unmarshal()` function behaves like `encoding/json#Unmarshal()` with the following differences:
The `UnmarshalCaseSensitivePreserveInts()` function behaves like `encoding/json#Unmarshal()` with the following differences:

- JSON object keys are treated case-sensitively.
Object keys must exactly match json tag names (for tagged struct fields)
Expand All @@ -21,7 +21,7 @@ The `Unmarshal()` function behaves like `encoding/json#Unmarshal()` with the fol

## Additional capabilities

The `UnmarshalStrict()` function decodes identically to `Unmarshal()`,
The `UnmarshalStrict()` function decodes identically to `UnmarshalCaseSensitivePreserveInts()`,
and also returns non-fatal strict errors encountered while decoding:

- Duplicate fields encountered
Expand Down

0 comments on commit cd512f1

Please sign in to comment.