Skip to content

Commit a54f56d

Browse files
Consistently use the "JEP-#" pattern (#145)
* Document the JEP-# pattern * Update "JEP N" to "JEP-N" in recent JEPs * Update "JEP N" to "JEP-N" in ported JEPs * Merged #146. Co-authored-by: Maxime Labelle <[email protected]>
1 parent 5b76bec commit a54f56d

7 files changed

+15
-15
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ proposal should be considered despite similar proposals not being accepted.
3232
Writing a JEP can be a lot of work, so it can help to get initial guidance before getting too far. You can chat on the JMESPath gitter channel
3333
(https://gitter.im/jmespath/chat) to get an initial pulse of a new feature.
3434

35-
Then open a [discussion](https://github.com/jmespath-community/jmespath.spec/discussions) to discuss the feature, its merit, and any possible
36-
alternatives. Once the discussion has reached a mature level of feedback it will be assigned a JEP#. At this point it is safe to begin composing a
37-
JEP, along with all the required changes and documentation.
35+
Then open a [discussion](https://github.com/jmespath-community/jmespath.spec/discussions) to discuss the feature, its merit, and any possible alternatives.
36+
Once the discussion has reached a mature level of feedback, it will be assigned a JEP number _N_.
37+
At that point it is safe to begin composing JEP-_N_ along with all the required changes and documentation.
3838

3939
### Tenets of JMESPath
4040

jep-003-functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -577,7 +577,7 @@ JMESPath expression.
577577

578578

579579
* This JEP originally proposed the literal syntax. The literal portion of this
580-
JEP was removed and added instead to JEP 7.
580+
JEP was removed and added instead to JEP-7.
581581

582582

583583
* This JEP originally specified that types matches should return null. This

jep-007-filter-expressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
This JEP proposes grammar modifications to JMESPath to allow for filter
1313
expressions. A filtered expression allows list elements to be selected
1414
based on matching expressions. A literal expression
15-
is also introduced (from JEP 3) so that it is possible to match elements
15+
is also introduced (from JEP-3) so that it is possible to match elements
1616
against literal values.
1717

1818
## Motivation

jep-009-improved-filters.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Abstract
1111

12-
JEP 7 introduced filter expressions, which is a mechanism to allow
12+
JEP-7 introduced filter expressions, which is a mechanism to allow
1313
list elements to be selected based on matching an expression against
1414
each list element. While this concept is useful, the actual comparator
1515
expressions were not sufficiently capable to accomodate a number of common
@@ -21,7 +21,7 @@ of queries.
2121

2222
## Motivation
2323

24-
JEP 7 introduced filter queries, that essentially look like this:
24+
JEP-7 introduced filter queries, that essentially look like this:
2525

2626
```
2727
foo[?lhs omparator rhs]
@@ -34,7 +34,7 @@ are both an `expression`, and comparator is one of
3434
This added a useful feature to JMESPath: the ability to filter
3535
a list based on evaluating an expression against each element in a list.
3636

37-
In the time since JEP 7 has been part of JMESPath, a number of cases have been
37+
In the time since JEP-7 has been part of JMESPath, a number of cases have been
3838
pointed out in which filter expressions cannot solve. Below are examples of
3939
each type of missing features.
4040

@@ -366,8 +366,8 @@ expressions, but is now allowed as a general `expression`.
366366
which again is just a general `expression`.
367367

368368
There are several reasons the previous grammar rules were minimally scoped.
369-
One of the main reasons, as stated in JEP 7 which introduced filter
369+
One of the main reasons, as stated in JEP-7 which introduced filter
370370
expressions, was to keep the spec “purposefully minimal.” In fact the end
371-
of JEP 7 states that there “are several extensions that can be added in
371+
of JEP-7 states that there “are several extensions that can be added in
372372
future.” This is in fact exactly what this JEP proposes, the recommendations
373-
from JEP 7.
373+
from JEP-7.

jep-010-slice-projections.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ flattening, and filtering projections.
1515

1616
## Motivation
1717

18-
JEP 5 introduced slice expressions. This added python slice semantics
18+
JEP-5 introduced slice expressions. This added python slice semantics
1919
to JSON. Slicing does not produce a projection so expressions such as
2020
the following will always return `null`: `myarray[:10].foo.bar`.
2121

jep-012-raw-string-literals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,9 @@ implementations.
277277
In order to support this type of variance in JMESPath implementations, all of
278278
the JSON literal compliance test cases that involve elided quotes MUST be
279279
removed, and test cases regarding failing on invalid unquoted JSON values MUST
280-
not be allowed in the compliance test unless placed in a JEP 12 specific
280+
not be allowed in the compliance test unless placed in a JEP-12 specific
281281
test suite, allowing implementations that support elided quotes in JSON
282-
literals to filter out the JEP 12 specific test cases.
282+
literals to filter out the JEP-12 specific test cases.
283283

284284
## Alternative approaches
285285

jep-015-string-slices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## Abstract
1212

13-
The original [JEP 5](https://github.com/jmespath-community/jmespath.spec/blob/main/jep-005-array-slices.md) introduced `slice-expression` in the grammar to slice specific portions of an array. While the syntax was specifically designed to operate on arrays, the syntactic grammar allows it after any expression.
13+
The original [JEP-5](https://github.com/jmespath-community/jmespath.spec/blob/main/jep-005-array-slices.md) introduced `slice-expression` in the grammar to slice specific portions of an array. While the syntax was specifically designed to operate on arrays, the syntactic grammar allows it after any expression.
1414

1515
This JEP introduces changes to allow `slice-expression` to operate on string types and act like a more powerful `substring()` function.
1616

0 commit comments

Comments
 (0)