Skip to content

Add codespell config, workflow to avoid adding typos. Fixed few typos still found #517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git,.codespellrc,rfc2629-xhtml.ent,*.out
check-hidden = true
# ignore-regex =
# ignore-words-list =
23 changes: 23 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Codespell configuration is within .codespellrc
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

permissions:
contents: read

jobs:
codespell:
name: Check for spelling errors
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4
- name: Codespell
uses: codespell-project/actions-codespell@v2
4 changes: 2 additions & 2 deletions draft-ietf-jsonpath-base.md
Original file line number Diff line number Diff line change
@@ -600,7 +600,7 @@ The syntax and semantics of segments are defined in {{segments-details}}.
In this document, the semantics of a JSONPath query define the
required results and do not prescribe the internal workings of an
implementation. This document may describe semantics in a procedural
step-by-step fashion, but such descriptions are normative only in the sense that any implementation MUST produce an identical result, but not in the sense that implementors are required to use the same algorithms.
step-by-step fashion, but such descriptions are normative only in the sense that any implementation MUST produce an identical result, but not in the sense that implementers are required to use the same algorithms.

The semantics are that a valid query is executed against a value,
the *query argument*, and produces a nodelist (i.e., a list of zero or more nodes of the value).
@@ -1872,7 +1872,7 @@ Queries:
The descendant segment consists of a double dot `..`
followed by a child segment (using bracket notation).

Shortand notations are also provided that correspond to the shorthand forms of the child segment.
Shorthand notations are also provided that correspond to the shorthand forms of the child segment.

~~~~ abnf
descendant-segment = ".." (bracketed-selection /
2 changes: 1 addition & 1 deletion scripts/soco.rb
Original file line number Diff line number Diff line change
@@ -82,6 +82,6 @@ def seginterpret(v, segs)
puts jsondata.to_yaml
end
else
puts "*** DIDNT EXPECT #{x.name}"
puts "*** DIDN'T EXPECT #{x.name}"
end
end