Skip to content

Commit c31f0d0

Browse files
Trottjasnell
authored andcommitted
doc: fix misplaced entries in test/common doc
One entry is placed in the wrong module and other entries are not in alphabetical order. PR-URL: #20117 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com>
1 parent 1fab8b4 commit c31f0d0

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

test/common/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,6 @@ Tests whether `name`, `expected`, and `code` are part of a raised warning. If
119119
an expected warning does not have a code then `common.noWarnCode` can be used
120120
to indicate this.
121121

122-
### noWarnCode
123-
See `common.expectWarning()` for usage.
124-
125122
### fileExists(pathname)
126123
* pathname [&lt;string>]
127124
* return [&lt;boolean>]
@@ -147,13 +144,11 @@ consisting of all `ArrayBufferView` and an `ArrayBuffer`.
147144

148145
Returns the file name and line number for the provided Function.
149146

150-
### runWithInvalidFD(func)
151-
* `func` [&lt;Function>]
147+
### getTTYfd()
152148

153-
Runs `func` with an invalid file descriptor that is an unsigned integer and
154-
can be used to trigger `EBADF` as the first argument. If no such file
155-
descriptor could be generated, a skip message will be printed and the `func`
156-
will not be run.
149+
Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.
150+
151+
The TTY file descriptor is assumed to be capable of being writable.
157152

158153
### globalCheck
159154
* [&lt;boolean>]
@@ -328,6 +323,9 @@ Returns `true` if the exit code `exitCode` and/or signal name `signal` represent
328323
the exit code and/or signal name of a node process that aborted, `false`
329324
otherwise.
330325

326+
### noWarnCode
327+
See `common.expectWarning()` for usage.
328+
331329
### opensslCli
332330
* [&lt;boolean>]
333331

@@ -369,6 +367,14 @@ original state after calling [`common.hijackStdOut()`][].
369367

370368
Path to the 'root' directory. either `/` or `c:\\` (windows)
371369

370+
### runWithInvalidFD(func)
371+
* `func` [&lt;Function>]
372+
373+
Runs `func` with an invalid file descriptor that is an unsigned integer and
374+
can be used to trigger `EBADF` as the first argument. If no such file
375+
descriptor could be generated, a skip message will be printed and the `func`
376+
will not be run.
377+
372378
### skip(msg)
373379
* `msg` [&lt;string>]
374380

@@ -695,12 +701,6 @@ The realpath of the testing temporary directory.
695701

696702
Deletes and recreates the testing temporary directory.
697703

698-
### getTTYfd()
699-
700-
Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.
701-
702-
The TTY file descriptor is assumed to be capable of being writable.
703-
704704
## WPT Module
705705

706706
The wpt.js module is a port of parts of

0 commit comments

Comments
 (0)