mirror of https://github.com/kdl-org/kdl.git
Assorted spelling fixes. (#548)
This commit is contained in:
parent
f238372fc9
commit
3b75764880
|
|
@ -56,7 +56,7 @@
|
||||||
* Around `=` for props (`x = 1`)
|
* Around `=` for props (`x = 1`)
|
||||||
* The BOM is now only allowed as the first character in a document. It was
|
* The BOM is now only allowed as the first character in a document. It was
|
||||||
previously treated as generic whitespace.
|
previously treated as generic whitespace.
|
||||||
* Multi-line strings must now use `"""` as delimeters. The opening delimiter must be immediately followed by a newline, and the closing delimiter must be on its own line, prefixed by optional whitespace.
|
* Multi-line strings must now use `"""` as delimiters. The opening delimiter must be immediately followed by a newline, and the closing delimiter must be on its own line, prefixed by optional whitespace.
|
||||||
* Multi-line strings are now automatically dedented, according to the common
|
* Multi-line strings are now automatically dedented, according to the common
|
||||||
whitespace matching the whitespace prefix of the closing line.
|
whitespace matching the whitespace prefix of the closing line.
|
||||||
* `.1`, `+.1` etc are no longer valid identifiers, to prevent confusion and
|
* `.1`, `+.1` etc are no longer valid identifiers, to prevent confusion and
|
||||||
|
|
|
||||||
|
|
@ -43,7 +43,7 @@ Arguments and children can be mixed, if desired. The preceding example could als
|
||||||
|
|
||||||
Two otherwise-ambiguous cases must be manually annotated with an `(array)` type annotation:
|
Two otherwise-ambiguous cases must be manually annotated with an `(array)` type annotation:
|
||||||
|
|
||||||
* A single-element array (such as `[1]`) written using arguments (as `- 1`) would be ambiguous with a literal node.
|
* A single-element array (such as `[1]`) written using arguments (as `- 1`) would be ambiguous with a literal node.
|
||||||
To indicate this is an array, it must be written as `(array)- 1`
|
To indicate this is an array, it must be written as `(array)- 1`
|
||||||
(Or rewritten to use child nodes, like `- { - 1 }`.)
|
(Or rewritten to use child nodes, like `- { - 1 }`.)
|
||||||
* An empty array (JSON `[]`) must use the `(array)` type annotation, like `(array)-`.
|
* An empty array (JSON `[]`) must use the `(array)` type annotation, like `(array)-`.
|
||||||
|
|
@ -57,7 +57,7 @@ JSON objects are represented in JiK as a node with any nodename, with zero or mo
|
||||||
Properties can encode literals - for example, the JSON `{"foo": 1, "bar": true}` can be written in JiK as `- foo=1 bar=#true`.
|
Properties can encode literals - for example, the JSON `{"foo": 1, "bar": true}` can be written in JiK as `- foo=1 bar=#true`.
|
||||||
|
|
||||||
Children can encode literals and/or nested arrays and objects,
|
Children can encode literals and/or nested arrays and objects,
|
||||||
using the nodename for the item's key.
|
using the nodename for the item's key.
|
||||||
|
|
||||||
For example, the JSON `{"foo": 1, "bar": [2, {"baz": 3}], "qux":4}` can be written in JiK as:
|
For example, the JSON `{"foo": 1, "bar": [2, {"baz": 3}], "qux":4}` can be written in JiK as:
|
||||||
|
|
||||||
|
|
@ -98,7 +98,7 @@ The properties and/or children of the node represent the items of the object,
|
||||||
with the property names and child nodenames as each item's key.
|
with the property names and child nodenames as each item's key.
|
||||||
All "keys" in an object node must be unique.
|
All "keys" in an object node must be unique.
|
||||||
|
|
||||||
As with arrays, there are two ambiguous cases that must be manually annoted with the `(object)` type annotation:
|
As with arrays, there are two ambiguous cases that must be manually annotated with the `(object)` type annotation:
|
||||||
|
|
||||||
* An object containing a single item whose key is "-" (like `{"-": 1}`) written using children (like `- { - 1 }`)
|
* An object containing a single item whose key is "-" (like `{"-": 1}`) written using children (like `- { - 1 }`)
|
||||||
would be ambiguous with an array node.
|
would be ambiguous with an array node.
|
||||||
|
|
@ -129,7 +129,7 @@ For simplicity, this document uses `-` for all such nodenames
|
||||||
but this means it is possible to write a JiK object as meaningful KDL
|
but this means it is possible to write a JiK object as meaningful KDL
|
||||||
and embed it within a larger KDL document.
|
and embed it within a larger KDL document.
|
||||||
|
|
||||||
Here's a fictitious example describing an HTTP request with a JSON body,
|
Here's a fictitious example describing an HTTP request with a JSON body,
|
||||||
where the `body` node is an embedded JiK node
|
where the `body` node is an embedded JiK node
|
||||||
that nevertheless reads as fairly natural KDL.
|
that nevertheless reads as fairly natural KDL.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -410,7 +410,7 @@ some restrictions about data representation. KDL is very similar in many ways, e
|
||||||
seemed like they could be improved.
|
seemed like they could be improved.
|
||||||
* There is only one "number" type. KDL does not prescribe representations, but
|
* There is only one "number" type. KDL does not prescribe representations, but
|
||||||
does have keywords for NaN, infinity, and negative infinity if decimal numbers
|
does have keywords for NaN, infinity, and negative infinity if decimal numbers
|
||||||
are intended to be represtented as IEEE754 floats.
|
are intended to be represented as IEEE754 floats.
|
||||||
* Slashdash (`/-`) comments are great and useful!
|
* Slashdash (`/-`) comments are great and useful!
|
||||||
* Quoteless "identifier" strings (e.g. `node foo=bar`, vs `node foo="bar"`).
|
* Quoteless "identifier" strings (e.g. `node foo=bar`, vs `node foo="bar"`).
|
||||||
* KDL does not have first-class date or binary data types. Instead, it
|
* KDL does not have first-class date or binary data types. Instead, it
|
||||||
|
|
|
||||||
|
|
@ -268,7 +268,7 @@ and property names when the `node-names` or `prop-names` options are activated.
|
||||||
|
|
||||||
* `tag`: [Validations](#validation-nodes) to apply to the tag of the value.
|
* `tag`: [Validations](#validation-nodes) to apply to the tag of the value.
|
||||||
* `type`: A string denoting the type of the property value.
|
* `type`: A string denoting the type of the property value.
|
||||||
* `enum`: A specific list of allowed values for this property. May be heterogenous as long as it agrees with the `type`, if specified.
|
* `enum`: A specific list of allowed values for this property. May be heterogeneous as long as it agrees with the `type`, if specified.
|
||||||
|
|
||||||
#### String validations
|
#### String validations
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -40,7 +40,7 @@ This is the formal specification for KDL, including the intended data model and
|
||||||
the grammar.
|
the grammar.
|
||||||
|
|
||||||
This document describes an unreleased minor change to KDL. For the latest
|
This document describes an unreleased minor change to KDL. For the latest
|
||||||
oficial version of the language, see https://kdl.dev/spec.
|
official version of the language, see https://kdl.dev/spec.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
This document describes KDL version KDL 2.0.0. It was released on 2024-12-21. It
|
This document describes KDL version KDL 2.0.0. It was released on 2024-12-21. It
|
||||||
|
|
@ -530,7 +530,7 @@ contain (if any). They do not have to start with the same whitespace prefix
|
||||||
that other lines do; all characters on the line are ignored.
|
that other lines do; all characters on the line are ignored.
|
||||||
|
|
||||||
Multi-line Strings that do not immediately start with a Newline and whose final
|
Multi-line Strings that do not immediately start with a Newline and whose final
|
||||||
`"""` is not preceeded by optional whitespace and a Newline are illegal. This
|
`"""` is not preceded by optional whitespace and a Newline are illegal. This
|
||||||
also means that `"""` may not be used for a single-line String (e.g.
|
also means that `"""` may not be used for a single-line String (e.g.
|
||||||
`"""foo"""`).
|
`"""foo"""`).
|
||||||
|
|
||||||
|
|
@ -802,7 +802,7 @@ They must be written with at least one integer digit, like `0.1`.
|
||||||
|
|
||||||
### Keyword Numbers
|
### Keyword Numbers
|
||||||
|
|
||||||
There are three special "keyword" numbers included in KDL to accomodate the
|
There are three special "keyword" numbers included in KDL to accommodate the
|
||||||
widespread use of [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754) floats:
|
widespread use of [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754) floats:
|
||||||
|
|
||||||
- `#inf` - floating point positive infinity.
|
- `#inf` - floating point positive infinity.
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue