Editorial improvements #41
Conversation
Thanks for feedback from Daniel Parker and Carsten Bormann.
draft-normington-jsonpath-latest.md
Outdated
| array-index = integer | ||
|
|
||
| integer = [%x2D] (%x30 / (%x31-39 *%x30-39)) | ||
| integer = ["-"] ("0" / (%x31-39 *%x30-39)) |
There was a problem hiding this comment.
You may want to make use of DIGIT and DIGIT1 here
draft-normington-jsonpath-latest.md
Outdated
|
|
||
| An array slice is a union element consisting of two or three integers (in | ||
| base 10 and which may be omitted) separated by colons. | ||
| An array slice is a union element consisting of optional integers (in base 10) separated by colons. |
There was a problem hiding this comment.
I think we need to be more aware about saying "is" when we mean "is represented by".
There was a problem hiding this comment.
Actually, I mean "is" rather than "is represented by". But the phrase "is a union element consisting of" is causing a lot of grief. It probably is better to make the array slice description independent of where it is used, thus:
| An array slice is a union element consisting of optional integers (in base 10) separated by colons. | |
| An array slice consists of optional integers (in base 10) separated by colons. |
draft-normington-jsonpath-latest.md
Outdated
| array-index = integer | ||
|
|
||
| integer = [%x2D] (%x30 / (%x31-39 *%x30-39)) | ||
| integer = ["-"] ("0" / (%x31-39 *%x30-39)) |
There was a problem hiding this comment.
What was the guidance around using quoted characters vs their hex equivalent?
There was a problem hiding this comment.
That change was based on input from @cabo.
There was a problem hiding this comment.
Could you link to the input? Why have both?
| array-slice = [ start ] ws ":" ws [ end ] | ||
| [ ws ":" ws [ step ] ] | ||
| start = integer | ||
| end = integer | ||
| step = integer |
There was a problem hiding this comment.
Does the markdown translation align the =?
There was a problem hiding this comment.
No. Does that matter?
There was a problem hiding this comment.
Typically I see them aligned for readability, but technically, no.
There was a problem hiding this comment.
I suggest we leave that for now and do a fine-tuning editorial pass later for consistency.
glyn
force-pushed
the
editorial-improvements
branch
from
380417d to
c88f2fa
Compare
Use term "JSON value" instead of "JSON document". Use "JSONPath" instead of "JSON Path" for consistency with Gössner.
glyn
force-pushed
the
editorial-improvements
branch
from
c88f2fa to
658ed7a
Compare
I'd like to merge so that @cabo can proceed to raise PRs which add introductory material from the Gössner draft. None of this is set in concrete, so there will be ample opportunities to revisit the text. |
|
@gregsdennis Merged. Let me know if you have outstanding issues and we can address them separately. |
Thanks for feedback from Daniel Parker and Carsten Bormann.