Skip to content

Commit 539187b

Browse files
handrewshandrews
committed
Add : to hanging list lables w short bodies
The main HTML rendering of the spec on the IETF site (and the plain text rendering) put the first line of a hanging text body on the same line as the label. When the bodies are each a single line, this looks like a weird spacing error rather than a labeled list. Use colons to make these lists more listy. This is *not* done with the body is itself a list, as the plain text formatting handles that in a way that is already clear, and the colon looks odd particularly for the list where the labels are JSON Pointers.
1 parent 7a6c26c commit 539187b

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

‎jsonschema-core.xml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -185,12 +185,12 @@
185185
depending on the type:
186186

187187
<list style="hanging">
188-
<t hangText="null">A JSON "null" production</t>
189-
<t hangText="boolean">A "true" or "false" value, from the JSON "true" or "false" productions</t>
190-
<t hangText="object">An unordered set of properties mapping a string to an instance, from the JSON "object" production</t>
191-
<t hangText="array">An ordered list of instances, from the JSON "array" production</t>
192-
<t hangText="number">An arbitrary-precision, base-10 decimal number value, from the JSON "number" production</t>
193-
<t hangText="string">A string of Unicode code points, from the JSON "string" production</t>
188+
<t hangText="null:">A JSON "null" production</t>
189+
<t hangText="boolean:">A "true" or "false" value, from the JSON "true" or "false" productions</t>
190+
<t hangText="object:">An unordered set of properties mapping a string to an instance, from the JSON "object" production</t>
191+
<t hangText="array:">An ordered list of instances, from the JSON "array" production</t>
192+
<t hangText="number:">An arbitrary-precision, base-10 decimal number value, from the JSON "number" production</t>
193+
<t hangText="string:">A string of Unicode code points, from the JSON "string" production</t>
194194
</list>
195195
</t>
196196
<t>
@@ -284,10 +284,10 @@
284284
or schema keywords. Broadly speaking, keywords fall into one or both
285285
of two categories:
286286
<list style="hanging">
287-
<t hangText="assertions">
287+
<t hangText="assertions:">
288288
produce a boolean result when applied to an instance
289289
</t>
290-
<t hangText="annotations">
290+
<t hangText="annotations:">
291291
attach information to an instance for application use
292292
</t>
293293
</list>
@@ -303,10 +303,10 @@
303303
in terms of the validation vocabulary, boolean schemas are equivalent to
304304
the following behaviors:
305305
<list style="hanging">
306-
<t hangText="true">
306+
<t hangText="true:">
307307
Always passes validation, as if the empty schema {}
308308
</t>
309-
<t hangText="false">
309+
<t hangText="false:">
310310
Always fails validation, as if the schema { "not":{} }
311311
</t>
312312
</list>
@@ -1045,7 +1045,7 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
10451045
<t>
10461046
Required parameters:
10471047
<list style="hanging">
1048-
<t hangText="schema">
1048+
<t hangText="schema:">
10491049
A non-empty list of space-separated URIs, each identifying
10501050
a JSON Schema resource. The instance SHOULD successfully
10511051
validate against at least one of these schemas.

‎jsonschema-validation.xml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -912,15 +912,15 @@
912912
Implementations supporting formats SHOULD implement support for
913913
the following attributes:
914914
<list style="hanging">
915-
<t hangText="date-time">
915+
<t hangText="date-time:">
916916
A string instance is valid against this attribute if it is
917917
a valid representation according to the "date-time" production.
918918
</t>
919-
<t hangText="date">
919+
<t hangText="date:">
920920
A string instance is valid against this attribute if it is
921921
a valid representation according to the "full-date" production.
922922
</t>
923-
<t hangText="time">
923+
<t hangText="time:">
924924
A string instance is valid against this attribute if it is
925925
a valid representation according to the "full-time" production.
926926
</t>
@@ -953,10 +953,10 @@
953953
A string instance is valid against these attributes if it is a valid
954954
Internet email address as follows:
955955
<list style="hanging">
956-
<t hangText="email">
956+
<t hangText="email:">
957957
As defined by <xref target="RFC5322">RFC 5322, section 3.4.1</xref>.
958958
</t>
959-
<t hangText="idn-email">
959+
<t hangText="idn-email:">
960960
As defined by <xref target="RFC6531">RFC 6531</xref>
961961
</t>
962962
</list>
@@ -972,12 +972,12 @@
972972
A string instance is valid against these attributes if it is a valid
973973
representation for an Internet hostname as follows:
974974
<list style="hanging">
975-
<t hangText="hostname">
975+
<t hangText="hostname:">
976976
As defined by <xref target="RFC1034">RFC 1034, section 3.1</xref>,
977977
including host names produced using the Punycode algorithm
978978
specified in <xref target="RFC5891">RFC 5891, section 4.4</xref>.
979979
</t>
980-
<t hangText="idn-hostname">
980+
<t hangText="idn-hostname:">
981981
As defined by either RFC 1034 as for hostname, or an
982982
internationalized hostname as defined by
983983
<xref target="RFC5890">RFC 5890, section 2.3.2.3</xref>.
@@ -996,12 +996,12 @@
996996
A string instance is valid against these attributes if it is a valid
997997
representation of an IP address as follows:
998998
<list style="hanging">
999-
<t hangText="ipv4">
999+
<t hangText="ipv4:">
10001000
An IPv4 address according to the "dotted-quad" ABNF
10011001
syntax as defined in
10021002
<xref target="RFC2673">RFC 2673, section 3.2</xref>.
10031003
</t>
1004-
<t hangText="ipv6">
1004+
<t hangText="ipv6:">
10051005
An IPv6 address as defined in
10061006
<xref target="RFC4291">RFC 4291, section 2.2</xref>.
10071007
</t>
@@ -1015,20 +1015,20 @@
10151015
</t>
10161016
<t>
10171017
<list style="hanging">
1018-
<t hangText="uri">
1018+
<t hangText="uri:">
10191019
A string instance is valid against this attribute if it is
10201020
a valid URI, according to <xref target="RFC3986"/>.
10211021
</t>
1022-
<t hangText="uri-reference">
1022+
<t hangText="uri-reference:">
10231023
A string instance is valid against this attribute if it is a valid URI
10241024
Reference (either a URI or a relative-reference),
10251025
according to <xref target="RFC3986"/>.
10261026
</t>
1027-
<t hangText="iri">
1027+
<t hangText="iri:">
10281028
A string instance is valid against this attribute if it is
10291029
a valid IRI, according to <xref target="RFC3987"/>.
10301030
</t>
1031-
<t hangText="iri-reference">
1031+
<t hangText="iri-reference:">
10321032
A string instance is valid against this attribute if it is a valid IRI
10331033
Reference (either an IRI or a relative-reference),
10341034
according to <xref target="RFC3987"/>.
@@ -1059,12 +1059,12 @@
10591059
</t>
10601060
<t>
10611061
<list style="hanging">
1062-
<t hangText="json-pointer">
1062+
<t hangText="json-pointer:">
10631063
A string instance is valid against this attribute if it
10641064
is a valid JSON string representation of a JSON Pointer,
10651065
according to <xref target="RFC6901">RFC 6901, section 5</xref>.
10661066
</t>
1067-
<t hangText="relative-json-pointer">
1067+
<t hangText="relative-json-pointer:">
10681068
A string instance is valid against this attribute if it is a valid
10691069
<xref target="relative-json-pointer">Relative JSON Pointer</xref>.
10701070
</t>

0 commit comments

Comments
 (0)