Skip to content

Commit f36a5e3

Browse files
AyushG3112MylesBorins
authored andcommitted
doc: remove redundant table of contents for N-API
Since the table of contents is built dynamically when building the documentation, the additional table of contents is redundant and an extra overhead to maintain. PR-URL: #20395 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 4bc87c1 commit f36a5e3

File tree

1 file changed

+0
-22
lines changed

1 file changed

+0
-22
lines changed

doc/api/n-api.md

-22
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,6 @@ properties:
3333
using `napi_get_last_error_info`. More information can be found in the error
3434
handling section [Error Handling][].
3535

36-
The documentation for N-API is structured as follows:
37-
38-
* [Basic N-API Data Types][]
39-
* [Error Handling][]
40-
* [Object Lifetime Management][]
41-
* [Module Registration][]
42-
* [Working with JavaScript Values][]
43-
* [Working with JavaScript Values - Abstract Operations][]
44-
* [Working with JavaScript Properties][]
45-
* [Working with JavaScript Functions][]
46-
* [Object Wrap][]
47-
* [Simple Asynchronous Operations][]
48-
* [Custom Asynchronous Operations][]
49-
* [Promises][]
50-
* [Script Execution][]
51-
5236
The N-API is a C API that ensures ABI stability across Node.js versions
5337
and different compiler levels. However, we also understand that a C++
5438
API can be easier to use in many cases. To support these cases we expect
@@ -3795,17 +3779,11 @@ NAPI_EXTERN napi_status napi_get_uv_event_loop(napi_env env,
37953779
- `[in] env`: The environment that the API is invoked under.
37963780
- `[out] loop`: The current libuv loop instance.
37973781

3798-
[Promises]: #n_api_promises
3799-
[Simple Asynchronous Operations]: #n_api_simple_asynchronous_operations
3800-
[Custom Asynchronous Operations]: #n_api_custom_asynchronous_operations
3801-
[Basic N-API Data Types]: #n_api_basic_n_api_data_types
38023782
[ECMAScript Language Specification]: https://tc39.github.io/ecma262/
38033783
[Error Handling]: #n_api_error_handling
3804-
[Module Registration]: #n_api_module_registration
38053784
[Native Abstractions for Node.js]: https://github.com/nodejs/nan
38063785
[Object Lifetime Management]: #n_api_object_lifetime_management
38073786
[Object Wrap]: #n_api_object_wrap
3808-
[Script Execution]: #n_api_script_execution
38093787
[Section 6.1.4]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type
38103788
[Section 6.1.6]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type
38113789
[Section 6.1.7.1]: https://tc39.github.io/ecma262/#table-2

0 commit comments

Comments
 (0)