Skip to content

Commit a5fe410

Browse files
committed
Address PR reivew comments
1 parent 6b74070 commit a5fe410

File tree

6 files changed

+38
-26
lines changed

6 files changed

+38
-26
lines changed

registries/_format/sf-binary.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields byte sequence as defined in [RFC 8941]
3+
issue:
4+
description: structured fields byte sequence as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences
66
source_label: RFC 8941
77
base_type: string
@@ -14,14 +14,16 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields byte sequence as defined in [RFC8941].
1818

1919
```abnf
2020
sf-binary = ":" *(base64) ":"
2121
base64 = ALPHA / DIGIT / "+" / "/" / "="
2222
```
2323

24-
A Byte Sequence is delimited with colons and encoded using base64 ([RFC 4648], Section 4).
24+
A Byte Sequence is delimited with colons and encoded using base64 ([RFC4648], Section 4).
25+
26+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
2527

2628
{% if page.issue %}
2729
### GitHub Issue
@@ -35,5 +37,5 @@ A Byte Sequence is delimited with colons and encoded using base64 ([RFC 4648], S
3537
{{ page.remarks }}
3638
{% endif %}
3739

38-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences
39-
[RFC 4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4
40+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-byte-sequences
41+
[RFC4648]: https://www.rfc-editor.org/rfc/rfc4648#section-4

registries/_format/sf-boolean.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields boolean as defined in [RFC 8941]
3+
issue:
4+
description: structured fields boolean as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-booleans
66
source_label: RFC 8941
77
base_type: string
@@ -14,7 +14,7 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields boolean as defined in [RFC8941].
1818

1919
```abnf
2020
sf-boolean = "?" boolean
@@ -23,6 +23,8 @@ boolean = "0" / "1"
2323

2424
A Boolean is indicated with a leading "?" character followed by a "1" for a true value or "0" for false.
2525

26+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
27+
2628
{% if page.issue %}
2729
### GitHub Issue
2830

@@ -35,4 +37,4 @@ A Boolean is indicated with a leading "?" character followed by a "1" for a true
3537
{{ page.remarks }}
3638
{% endif %}
3739

38-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-booleans
40+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-booleans

registries/_format/sf-decimal.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields decimal as defined in [RFC 8941]
3+
issue:
4+
description: structured fields decimal as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-decimals
66
source_label: RFC 8941
77
base_type: number
@@ -14,7 +14,7 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields decimal as defined in [RFC8941].
1818

1919
```abnf
2020
sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT
@@ -23,6 +23,8 @@ sf-decimal = ["-"] 1*12DIGIT "." 1*3DIGIT
2323
Decimals are numbers with an integer and a fractional component.
2424
The integer component has at most 12 digits; the fractional component has at most three digits.
2525

26+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
27+
2628
{% if page.issue %}
2729
### GitHub Issue
2830

@@ -35,4 +37,4 @@ The integer component has at most 12 digits; the fractional component has at mos
3537
{{ page.remarks }}
3638
{% endif %}
3739

38-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-decimals
40+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-decimals

registries/_format/sf-integer.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields integer as defined in [RFC 8941]
3+
issue:
4+
description: structured fields integer as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-integers
66
source_label: RFC 8941
77
base_type: integer, number
@@ -14,7 +14,7 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields integer as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields integer as defined in [RFC8941].
1818

1919
```abnf
2020
sf-integer = ["-"] 1*15DIGIT
@@ -23,6 +23,8 @@ sf-integer = ["-"] 1*15DIGIT
2323
Integers have a range of -999,999,999,999,999 to 999,999,999,999,999 inclusive (i.e., up to fifteen digits, signed),
2424
for IEEE 754 compatibility [IEEE754].
2525

26+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
27+
2628
{% if page.issue %}
2729
### GitHub Issue
2830

@@ -35,5 +37,5 @@ for IEEE 754 compatibility [IEEE754].
3537
{{ page.remarks }}
3638
{% endif %}
3739

38-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-integers
40+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-integers
3941
[IEEE754]: https://ieeexplore.ieee.org/document/8766229

registries/_format/sf-string.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields string as defined in [RFC 8941]
3+
issue:
4+
description: structured fields string as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-strings
66
source_label: RFC 8941
77
base_type: string
@@ -14,7 +14,7 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields string as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields string as defined in [RFC8941].
1818

1919
```abnf
2020
sf-string = DQUOTE *chr DQUOTE
@@ -28,6 +28,8 @@ Note that this excludes tabs, newlines, carriage returns, etc.
2828

2929
Strings are delimited with double quotes, using a backslash ("\") to escape double quotes and backslashes.
3030

31+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
32+
3133
{% if page.issue %}
3234
### GitHub Issue
3335

@@ -40,4 +42,4 @@ Strings are delimited with double quotes, using a backslash ("\") to escape doub
4042
{{ page.remarks }}
4143
{% endif %}
4244

43-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-strings
45+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-strings

registries/_format/sf-token.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
owner: mikekistler
3-
issue:
4-
description: structured fields token as defined in [RFC 8941]
3+
issue:
4+
description: structured fields token as defined in [RFC8941]
55
source: https://www.rfc-editor.org/rfc/rfc8941#name-tokens
66
source_label: RFC 8941
77
base_type: string
@@ -14,14 +14,16 @@ layout: default
1414

1515
Base type: `{{ page.base_type }}`.
1616

17-
The `{{page.slug}}` format represents a structured fields token as defined in [RFC 8941].
17+
The `{{page.slug}}` format represents a structured fields token as defined in [RFC8941].
1818

1919
```abnf
2020
sf-token = ( ALPHA / "*" ) *( tchar / ":" / "/" )
2121
```
2222

2323
Tokens are short textual words; their abstract model is identical to their expression in the HTTP field value serialization.
2424

25+
This format is appropriate for a header value that must conform to the {{page.slug}} structured field definition.
26+
2527
{% if page.issue %}
2628
### GitHub Issue
2729

@@ -34,4 +36,4 @@ Tokens are short textual words; their abstract model is identical to their expre
3436
{{ page.remarks }}
3537
{% endif %}
3638

37-
[RFC 8941]: https://www.rfc-editor.org/rfc/rfc8941#name-tokens
39+
[RFC8941]: https://www.rfc-editor.org/rfc/rfc8941#name-tokens

0 commit comments

Comments
 (0)