Skip to content

Commit 686dd36

Browse files
watildejasnell
authored andcommitted
doc: fix api docs style
doc/api/fs.md + L314: Missing code-language flag doc/api/stream.md + L2120: Do not use definitions with the same identifier + L2121: Do not use definitions with the same identifier + L2122: Do not use definitions with the same identifier doc/api/v8.md + L157: Move definitions to the end of the file + L158: Move definitions to the end of the file + L159: Move definitions to the end of the file + L160: Move definitions to the end of the file PR-URL: #13236 Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent c8be718 commit 686dd36

File tree

3 files changed

+5
-9
lines changed

3 files changed

+5
-9
lines changed

doc/api/fs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ synchronous counterparts are of this type.
311311
For a regular file [`util.inspect(stats)`][] would return a string very
312312
similar to this:
313313

314-
```
314+
```console
315315
Stats {
316316
dev: 2114,
317317
ino: 48064969,

doc/api/stream.md

-3
Original file line numberDiff line numberDiff line change
@@ -2174,6 +2174,3 @@ readable buffer so there is nothing for a user to consume.
21742174
[stream-write]: #stream_writable_write_chunk_encoding_callback
21752175
[readable-_destroy]: #stream_readable_destroy_err_callback
21762176
[writable-_destroy]: #stream_writable_destroy_err_callback
2177-
[TCP sockets]: net.html#net_class_net_socket
2178-
[Transform]: #stream_class_stream_transform
2179-
[Writable]: #stream_class_stream_writable

doc/api/v8.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -154,11 +154,6 @@ v8.setFlagsFromString('--trace_gc');
154154
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
155155
```
156156

157-
[V8]: https://developers.google.com/v8/
158-
[`vm.Script`]: vm.html#vm_new_vm_script_code_options
159-
[here]: https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md
160-
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-5.0/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4
161-
162157
## Serialization API
163158

164159
> Stability: 1 - Experimental
@@ -409,3 +404,7 @@ A subclass of [`Deserializer`][] corresponding to the format written by
409404
[`serializer.transferArrayBuffer()`]: #v8_serializer_transferarraybuffer_id_arraybuffer
410405
[`serializer.writeRawBytes()`]: #v8_serializer_writerawbytes_buffer
411406
[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
407+
[V8]: https://developers.google.com/v8/
408+
[`vm.Script`]: vm.html#vm_new_vm_script_code_options
409+
[here]: https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md
410+
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-5.0/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4

0 commit comments

Comments
 (0)