Browse Source

doc: fix some links

PR-URL: https://github.com/nodejs/node/pull/14400
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: James M Snell <jasnell@gmail.com>
v6
Vse Mozhet Byt 8 years ago
parent
commit
4d1e0862ce
  1. 6
      doc/api/dns.md
  2. 1
      doc/api/n-api.md
  3. 2
      doc/api/v8.md
  4. 19
      doc/guides/writing-tests.md

6
doc/api/dns.md

@ -191,7 +191,7 @@ added: v0.1.27
- `rrtype` {string} Resource record type. Default: `'A'`. - `rrtype` {string} Resource record type. Default: `'A'`.
- `callback` {Function} - `callback` {Function}
- `err` {Error} - `err` {Error}
- `records` {string[] | Object[] | string[][] | Object} - `records` {string[] | Object[] | Object}
Uses the DNS protocol to resolve a hostname (e.g. `'nodejs.org'`) into an array Uses the DNS protocol to resolve a hostname (e.g. `'nodejs.org'`) into an array
of the resource records. The `callback` function has arguments of the resource records. The `callback` function has arguments
@ -422,7 +422,7 @@ added: v0.1.27
- `hostname` {string} - `hostname` {string}
- `callback` {Function} - `callback` {Function}
- `err` {Error} - `err` {Error}
- `addresses` {string[][]} - `addresses` {string[]}
Uses the DNS protocol to resolve text queries (`TXT` records) for the Uses the DNS protocol to resolve text queries (`TXT` records) for the
`hostname`. The `addresses` argument passed to the `callback` function is `hostname`. The `addresses` argument passed to the `callback` function is
@ -436,7 +436,7 @@ treated separately.
- `hostname` {string} - `hostname` {string}
- `callback` {Function} - `callback` {Function}
- `err` {Error} - `err` {Error}
- `ret` {Object[][]} - `ret` {Object[]}
Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query). Uses the DNS protocol to resolve all records (also known as `ANY` or `*` query).
The `ret` argument passed to the `callback` function will be an array containing The `ret` argument passed to the `callback` function will be an array containing

1
doc/api/n-api.md

@ -3203,6 +3203,7 @@ support it:
[`napi_queue_async_work`]: #n_api_napi_queue_async_work [`napi_queue_async_work`]: #n_api_napi_queue_async_work
[`napi_reference_ref`]: #n_api_napi_reference_ref [`napi_reference_ref`]: #n_api_napi_reference_ref
[`napi_reference_unref`]: #n_api_napi_reference_unref [`napi_reference_unref`]: #n_api_napi_reference_unref
[`napi_throw`]: #n_api_napi_throw
[`napi_throw_error`]: #n_api_napi_throw_error [`napi_throw_error`]: #n_api_napi_throw_error
[`napi_throw_range_error`]: #n_api_napi_throw_range_error [`napi_throw_range_error`]: #n_api_napi_throw_range_error
[`napi_throw_type_error`]: #n_api_napi_throw_type_error [`napi_throw_type_error`]: #n_api_napi_throw_type_error

2
doc/api/v8.md

@ -289,7 +289,7 @@ by subclasses.
* `flag` {boolean} * `flag` {boolean}
Indicate whether to treat `TypedArray` and `DataView` objects as Indicate whether to treat `TypedArray` and `DataView` objects as
host objects, i.e. pass them to [`serializer._writeHostObject`][]. host objects, i.e. pass them to [`serializer._writeHostObject()`][].
The default is not to treat those objects as host objects. The default is not to treat those objects as host objects.

19
doc/guides/writing-tests.md

@ -92,7 +92,7 @@ The test checks functionality in the `http` module.
Most tests use the `assert` module to confirm expectations of the test. Most tests use the `assert` module to confirm expectations of the test.
The require statements are sorted in The require statements are sorted in
[ASCII](http://man7.org/linux/man-pages/man7/ascii.7.html) order (digits, upper [ASCII][] order (digits, upper
case, `_`, lower case). case, `_`, lower case).
### **Lines 10-21** ### **Lines 10-21**
@ -231,9 +231,9 @@ assert.throws(
For performance considerations, we only use a selected subset of ES.Next For performance considerations, we only use a selected subset of ES.Next
features in JavaScript code in the `lib` directory. However, when writing features in JavaScript code in the `lib` directory. However, when writing
tests, for the ease of backporting, it is encouraged to use those ES.Next tests, for the ease of backporting, it is encouraged to use those ES.Next
features that can be used directly without a flag in [all maintained branches] features that can be used directly without a flag in
(https://github.com/nodejs/lts). [node.green](http://node.green/) lists [all maintained branches][]. [node.green][] lists available features
available features in each release. in each release.
For example: For example:
@ -258,8 +258,7 @@ functions worked correctly with the `beforeExit` event, then it might be named
### Web Platform Tests ### Web Platform Tests
Some of the tests for the WHATWG URL implementation (named Some of the tests for the WHATWG URL implementation (named
`test-whatwg-url-*.js`) are imported from the `test-whatwg-url-*.js`) are imported from the [Web Platform Tests Project][].
[Web Platform Tests Project](https://github.com/w3c/web-platform-tests/tree/master/url).
These imported tests will be wrapped like this: These imported tests will be wrapped like this:
```js ```js
@ -332,13 +331,17 @@ $ make cctest
``` ```
### Node test fixture ### Node test fixture
There is a [test fixture] named `node_test_fixture.h` which can be included by There is a [test fixture][] named `node_test_fixture.h` which can be included by
unit tests. The fixture takes care of setting up the Node.js environment unit tests. The fixture takes care of setting up the Node.js environment
and tearing it down after the tests have finished. and tearing it down after the tests have finished.
It also contains a helper to create arguments to be passed into Node.js. It It also contains a helper to create arguments to be passed into Node.js. It
will depend on what is being tested if this is required or not. will depend on what is being tested if this is required or not.
[ASCII]: http://man7.org/linux/man-pages/man7/ascii.7.html
[Google Test]: https://github.com/google/googletest [Google Test]: https://github.com/google/googletest
[Test fixture]: https://github.com/google/googletest/blob/master/googletest/docs/Primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests [Web Platform Tests Project]: https://github.com/w3c/web-platform-tests/tree/master/url
[`common` module]: https://github.com/nodejs/node/blob/master/test/common/README.md [`common` module]: https://github.com/nodejs/node/blob/master/test/common/README.md
[all maintained branches]: https://github.com/nodejs/lts
[node.green]: http://node.green/
[test fixture]: https://github.com/google/googletest/blob/master/googletest/docs/Primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests

Loading…
Cancel
Save