Skip to content

Commit

Permalink
doc: fix api docs style
Browse files Browse the repository at this point in the history
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 <refack@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information
watilde authored and jasnell committed May 29, 2017
1 parent c8be718 commit 686dd36
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ synchronous counterparts are of this type.
For a regular file [`util.inspect(stats)`][] would return a string very
similar to this:

```
```console
Stats {
dev: 2114,
ino: 48064969,
Expand Down
3 changes: 0 additions & 3 deletions doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -2174,6 +2174,3 @@ readable buffer so there is nothing for a user to consume.
[stream-write]: #stream_writable_write_chunk_encoding_callback
[readable-_destroy]: #stream_readable_destroy_err_callback
[writable-_destroy]: #stream_writable_destroy_err_callback
[TCP sockets]: net.html#net_class_net_socket
[Transform]: #stream_class_stream_transform
[Writable]: #stream_class_stream_writable
9 changes: 4 additions & 5 deletions doc/api/v8.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,11 +154,6 @@ v8.setFlagsFromString('--trace_gc');
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
```

[V8]: https://developers.google.com/v8/
[`vm.Script`]: vm.html#vm_new_vm_script_code_options
[here]: https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md
[`GetHeapSpaceStatistics`]: https://v8docs.nodesource.com/node-5.0/d5/dda/classv8_1_1_isolate.html#ac673576f24fdc7a33378f8f57e1d13a4

## Serialization API

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

0 comments on commit 686dd36

Please sign in to comment.