New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix api docs style #13236

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
8 participants
@watilde
Member

watilde commented May 26, 2017

Same with this: #13066. To avoid more conflicts at #12756, it's better to fix mdlint errors in upstream.

Summary

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
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

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
@@ -2145,6 +2145,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

This comment has been minimized.

@watilde

watilde May 26, 2017

Member

they were duplicated on doc/api/stream.md#L2125-L2127.

@watilde

watilde May 26, 2017

Member

they were duplicated on doc/api/stream.md#L2125-L2127.

@lpinca

lpinca approved these changes May 26, 2017

@refack

refack approved these changes May 26, 2017

@addaleax

Thank you!

@aqrln

aqrln approved these changes May 26, 2017

@mhdawson

LGTM

@watilde

This comment has been minimized.

Show comment
Hide comment
@watilde

watilde May 28, 2017

Member

Landed in a94b98e. Thanks!

Member

watilde commented May 28, 2017

Landed in a94b98e. Thanks!

@watilde watilde closed this May 28, 2017

@watilde watilde deleted the watilde:feature/fix-docs branch May 28, 2017

watilde added a commit that referenced this pull request May 28, 2017

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 <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>

jasnell added a commit that referenced this pull request May 29, 2017

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 <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>

@gibfahn gibfahn referenced this pull request Jun 15, 2017

Closed

Auditing for 6.11.1 #230

2 of 3 tasks complete
@MylesBorins

This comment has been minimized.

Show comment
Hide comment
@MylesBorins

MylesBorins Jul 17, 2017

Member

This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace do-not-land if it is being backported

Member

MylesBorins commented Jul 17, 2017

This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace do-not-land if it is being backported

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment