Skip to content

Commit

Permalink
Merge pull request #354 from rustfix/master
Browse files Browse the repository at this point in the history
chore: fix some typos in comments
  • Loading branch information
tidwall authored Apr 23, 2024
2 parents bbf40bb + 5d0d40c commit 2ba56cc
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions SYNTAX.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GJSON Path Syntax

A GJSON Path is a text string syntax that describes a search pattern for quickly retreiving values from a JSON payload.
A GJSON Path is a text string syntax that describes a search pattern for quickly retrieving values from a JSON payload.

This document is designed to explain the structure of a GJSON Path through examples.

Expand All @@ -15,12 +15,12 @@ This document is designed to explain the structure of a GJSON Path through examp
- [Multipaths](#multipaths)
- [Literals](#literals)

The definitive implemenation is [github.com/tidwall/gjson](https://github.com/tidwall/gjson).
The definitive implementation is [github.com/tidwall/gjson](https://github.com/tidwall/gjson).
Use the [GJSON Playground](https://gjson.dev) to experiment with the syntax online.

## Path structure

A GJSON Path is intended to be easily expressed as a series of components seperated by a `.` character.
A GJSON Path is intended to be easily expressed as a series of components separated by a `.` character.

Along with `.` character, there are a few more that have special meaning, including `|`, `#`, `@`, `\`, `*`, `!`, and `?`.

Expand All @@ -46,7 +46,7 @@ The following GJSON Paths evaluate to the accompanying values.

### Basic

In many cases you'll just want to retreive values by object name or array index.
In many cases you'll just want to retrieve values by object name or array index.

```go
name.last "Anderson"
Expand Down
6 changes: 3 additions & 3 deletions gjson.go
Original file line number Diff line number Diff line change
Expand Up @@ -1252,7 +1252,7 @@ func parseObject(c *parseContext, i int, path string) (int, bool) {
}

// matchLimit will limit the complexity of the match operation to avoid ReDos
// attacks from arbritary inputs.
// attacks from arbitrary inputs.
// See the github.com/tidwall/match.MatchLimit function for more information.
func matchLimit(str, pattern string) bool {
matched, _ := match.MatchLimit(str, pattern, 10000)
Expand Down Expand Up @@ -2194,7 +2194,7 @@ func unescape(json string) string {
}

// Less return true if a token is less than another token.
// The caseSensitive paramater is used when the tokens are Strings.
// The caseSensitive parameter is used when the tokens are Strings.
// The order when comparing two different type is:
//
// Null < False < Number < String < True < JSON
Expand Down Expand Up @@ -3353,7 +3353,7 @@ func (t Result) Path(json string) string {
goto fail
}
if !strings.HasPrefix(json[t.Index:], t.Raw) {
// Result is not at the JSON index as exepcted.
// Result is not at the JSON index as expected.
goto fail
}
for ; i >= 0; i-- {
Expand Down

0 comments on commit 2ba56cc

Please sign in to comment.