Skip to content

Commit 00a981a

Browse files
committed
Add "Operands" and "Options" sections to look like registry.md function definitions
1 parent 1340f79 commit 00a981a

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

test/README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,19 @@ the following functions are defined for **test use only**:
4646
### `:test:function`
4747

4848
This function is valid both as a selector and as a formatter.
49-
The only option it recognizes is `fd`,
50-
all other option values passed to it are ignored.
49+
50+
#### Operands
51+
52+
The function `:test:function` requires a [Number Operand](/spec/registry.md#number-operands) as its _operand_.
53+
54+
#### Options
55+
56+
The only option `:test:function` recognizes is `fd`,
57+
a [digit size option](/spec/registry.md) for which only `0` and `1` are valid values.
58+
59+
All other options and their values are ignored.
60+
61+
#### Behavior
5162

5263
When resolving a `:test:function` expression,
5364
its _Input_ and _FD_ values are determined as follows:
@@ -109,7 +120,8 @@ Note that for purposes of clarity, the formatting of `:test:function` does not p
109120

110121
### `:test:select`
111122

112-
This function behaves exactly the same as `:test:function`,
123+
This function accepts the same operands and options,
124+
and behaves exactly the same as `:test:function`,
113125
except that it cannot be used for formatting.
114126

115127
When `:test:select` is used as a formatter,
@@ -118,7 +130,8 @@ a fallback representation.
118130

119131
### `:test:format`
120132

121-
This function behaves exactly the same as `:test:function`,
133+
This function accepts the same operands and options,
134+
and behaves exactly the same as `:test:function`,
122135
except that it cannot be used for selection.
123136

124137
When `:test:format` is used as a selector,

0 commit comments

Comments
 (0)