Skip to content

Commit 7937fbe

Browse files
Trotttargos
authored andcommitted
doc: update tables in README files for linting changes
PR-URL: #35905 Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Shelley Vohr <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
1 parent c5b9422 commit 7937fbe

File tree

2 files changed

+34
-34
lines changed

2 files changed

+34
-34
lines changed

src/README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -495,16 +495,16 @@ The most common reasons for this are:
495495
holds a value of type `Local<T>`. It has methods that perform the same
496496
operations as the methods of `v8::Maybe`, but with different names:
497497

498-
| `Maybe` | `MaybeLocal` |
499-
| ---------------------- | ------------------------------- |
500-
| `maybe.IsNothing()` | `maybe_local.IsEmpty()` |
501-
| `maybe.IsJust()` | `!maybe_local.IsEmpty()` |
502-
| `maybe.To(&value)` | `maybe_local.ToLocal(&local)` |
503-
| `maybe.ToChecked()` | `maybe_local.ToLocalChecked()` |
504-
| `maybe.FromJust()` | `maybe_local.ToLocalChecked()` |
505-
| `maybe.Check()` | |
506-
| `v8::Nothing<T>()` | `v8::MaybeLocal<T>()` |
507-
| `v8::Just<T>(value)` | `v8::MaybeLocal<T>(value)` |
498+
| `Maybe` | `MaybeLocal` |
499+
| -------------------- | ------------------------------ |
500+
| `maybe.IsNothing()` | `maybe_local.IsEmpty()` |
501+
| `maybe.IsJust()` | `!maybe_local.IsEmpty()` |
502+
| `maybe.To(&value)` | `maybe_local.ToLocal(&local)` |
503+
| `maybe.ToChecked()` | `maybe_local.ToLocalChecked()` |
504+
| `maybe.FromJust()` | `maybe_local.ToLocalChecked()` |
505+
| `maybe.Check()` ||
506+
| `v8::Nothing<T>()` | `v8::MaybeLocal<T>()` |
507+
| `v8::Just<T>(value)` | `v8::MaybeLocal<T>(value)` |
508508

509509
##### Handling empty `Maybe`s
510510

test/README.md

+24-24
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,27 @@ For the tests to run on Windows, be sure to clone Node.js source code with the
1313

1414
## Test Directories
1515

16-
| Directory | Runs on CI | Purpose |
17-
| ------------------- | --------------- | --------------- |
18-
| `abort` | Yes | Tests for when the `--abort-on-uncaught-exception` flag is used. |
19-
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20-
| `async-hooks` | Yes | Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality. |
21-
| `benchmark` | No | Test minimal functionality of benchmarks. |
22-
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23-
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24-
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25-
| `doctool` | Yes | Tests for the documentation generator. |
26-
| `es-module` | Yes | Test ESM module loading. |
27-
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28-
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29-
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30-
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31-
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32-
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33-
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34-
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35-
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36-
| `sequential` | Yes | Various tests that must not run in parallel. |
37-
| `testpy` | | Test configuration utility used by various test suites. |
38-
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39-
| `v8-updates` | No | Tests for V8 performance integration. |
16+
| Directory | Runs on CI | Purpose |
17+
| ---------------- | ---------- | --------------- |
18+
| `abort` | Yes | Tests for when the `--abort-on-uncaught-exception` flag is used. |
19+
| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. |
20+
| `async-hooks` | Yes | Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality. |
21+
| `benchmark` | No | Test minimal functionality of benchmarks. |
22+
| `cctest` | Yes | C++ tests that are run as part of the build process. |
23+
| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. |
24+
| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) |
25+
| `doctool` | Yes | Tests for the documentation generator. |
26+
| `es-module` | Yes | Test ESM module loading. |
27+
| `fixtures` | | Test fixtures used in various tests throughout the test suite. |
28+
| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. |
29+
| `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. |
30+
| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. |
31+
| `message` | Yes | Tests for messages that are output for various conditions (`console.log`, error messages etc.) |
32+
| `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. |
33+
| `parallel` | Yes | Various tests that are able to be run in parallel. |
34+
| `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. |
35+
| `pummel` | No | Various tests for various modules / system functionality operating under load. |
36+
| `sequential` | Yes | Various tests that must not run in parallel. |
37+
| `testpy` | | Test configuration utility used by various test suites. |
38+
| `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in `lib/internal/v8_prof_processor.js` and `lib/internal/v8_prof_polyfill.js`. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. |
39+
| `v8-updates` | No | Tests for V8 performance integration. |

0 commit comments

Comments
 (0)