diff options
author | James M Snell <jasnell@gmail.com> | 2018-02-05 21:55:16 -0800 |
---|---|---|
committer | Anatoli Papirovski <apapirovski@mac.com> | 2018-02-08 11:57:14 -0500 |
commit | d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch) | |
tree | 643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/n-api.md | |
parent | 809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff) | |
download | android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.gz android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.bz2 android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.zip |
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs.
PR-URL: https://github.com/nodejs/node/pull/18592
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/n-api.md')
-rw-r--r-- | doc/api/n-api.md | 46 |
1 files changed, 22 insertions, 24 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 38cf7a8842..3a954bd0d5 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -250,9 +250,9 @@ typedef struct napi_extended_error_info { [`napi_get_last_error_info`][] returns the information for the last N-API call that was made. -*Note*: Do not rely on the content or format of any of the extended -information as it is not subject to SemVer and may change at any time. -It is intended only for logging purposes. +Do not rely on the content or format of any of the extended information as it +is not subject to SemVer and may change at any time. It is intended only for +logging purposes. #### napi_get_last_error_info <!-- YAML @@ -272,12 +272,12 @@ Returns `napi_ok` if the API succeeded. This API retrieves a `napi_extended_error_info` structure with information about the last error that occurred. -*Note*: The content of the `napi_extended_error_info` returned is only -valid up until an n-api function is called on the same `env`. +The content of the `napi_extended_error_info` returned is only valid up until +an n-api function is called on the same `env`. -*Note*: Do not rely on the content or format of any of the extended -information as it is not subject to SemVer and may change at any time. -It is intended only for logging purposes. +Do not rely on the content or format of any of the extended information as it +is not subject to SemVer and may change at any time. It is intended only for +logging purposes. ### Exceptions @@ -1169,9 +1169,9 @@ later by native code. The API allows the caller to pass in a finalize callback, in case the underlying native resource needs to be cleaned up when the external JavaScript value gets collected. -*Note*: The created value is not an object, and therefore does not support -additional properties. It is considered a distinct value type: calling -`napi_typeof()` with an external value yields `napi_external`. +The created value is not an object, and therefore does not support additional +properties. It is considered a distinct value type: calling `napi_typeof()` with +an external value yields `napi_external`. #### napi_create_external_arraybuffer <!-- YAML @@ -1236,7 +1236,7 @@ This API allocates a `node::Buffer` object and initializes it with data backed by the passed in buffer. While this is still a fully-supported data structure, in most cases using a TypedArray will suffice. -*Note*: For Node.js >=4 `Buffers` are Uint8Arrays. +For Node.js >=4 `Buffers` are Uint8Arrays. #### napi_create_function <!-- YAML @@ -2850,10 +2850,9 @@ This API allows an add-on author to create a function object in native code. This is the primary mechanism to allow calling *into* the add-on's native code *from* JavaScript. -*Note*: The newly created function is not automatically visible from -script after this call. Instead, a property must be explicitly set on any -object that is visible to JavaScript, in order for the function to be accessible -from script. +The newly created function is not automatically visible from script after this +call. Instead, a property must be explicitly set on any object that is visible +to JavaScript, in order for the function to be accessible from script. In order to expose a function as part of the add-on's module exports, set the newly created function on the exports @@ -2886,7 +2885,7 @@ const myaddon = require('./addon'); myaddon.sayHello(); ``` -*Note*: The string passed to require is not necessarily the name passed into +The string passed to require is not necessarily the name passed into `NAPI_MODULE` in the earlier snippet but the name of the target in `binding.gyp` responsible for creating the `.node` file. @@ -3142,8 +3141,8 @@ invocation. (If it is deleted before then, then the finalize callback may never be invoked.) Therefore, when obtaining a reference a finalize callback is also required in order to enable correct proper of the reference. -*Note*: This API may modify the prototype chain of the wrapper object. -Afterward, additional manipulation of the wrapper's prototype chain may cause +This API may modify the prototype chain of the wrapper object. Afterward, +additional manipulation of the wrapper's prototype chain may cause `napi_unwrap()` to fail. Calling napi_wrap() a second time on an object will return an error. To associate @@ -3284,11 +3283,10 @@ required. `async_resource_name` should be a null-terminated, UTF-8-encoded string. -*Note*: The `async_resource_name` identifier is provided by the user and should -be representative of the type of async work being performed. It is also -recommended to apply namespacing to the identifier, e.g. by including the -module name. See the [`async_hooks` documentation][async_hooks `type`] -for more information. +The `async_resource_name` identifier is provided by the user and should be +representative of the type of async work being performed. It is also recommended +to apply namespacing to the identifier, e.g. by including the module name. See +the [`async_hooks` documentation][async_hooks `type`] for more information. ### napi_delete_async_work <!-- YAML |