Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc: removed extra explanation in api/buffer.md #17796

Closed
wants to merge 1 commit into from
Closed

doc: removed extra explanation in api/buffer.md #17796

wants to merge 1 commit into from

Conversation

WaleedAshraf
Copy link
Contributor

@WaleedAshraf WaleedAshraf commented Dec 20, 2017 •
edited
Loading

Closes : #17618

Checklist
Affected core subsystem(s)

doc/api/buffer

@nodejs-github-bot nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Dec 20, 2017
@WaleedAshraf WaleedAshraf mentioned this pull request Dec 20, 2017
Closed
1 task
apapirovski
apapirovski approved these changes Dec 20, 2017
View reviewed changes
Copy link
Member

@apapirovski apapirovski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but the square brackets around buf.length seem wrong to me (but I know that's not from this PR). Could be changed in this PR or a separate one afterwards, unless there's something I'm missing re: why they're there.

@WaleedAshraf
Copy link
Contributor Author

@apapirovski square brackets are defined to link keyword with its description link/tag in document. Though it was not the right one. I have added the fix in latest commit.

@apapirovski
Copy link
Member

@WaleedAshraf Well, that just makes it even more confusing given that target.length refers to the same thing but doesn't link. Also, other instances of "buf.length" in "Default" don't link. But still... don't change anything yet, maybe others have a different opinion on this.

Btw that link was correct, it works as expected when used in our generated documentation. See https://nodejs.org/dist/latest-v8.x/docs/api/buffer.html#buffer_buf_length

@WaleedAshraf
Copy link
Contributor Author

WaleedAshraf commented Dec 20, 2017 •
edited
Loading

Ops! It doesnt work in git only than. Let me undo last commit.
Agreed. target.length is also same. But doesn't link. And many occurrences of buf.length also doesn't link.
Sure, lets wait for review from others.

@maclover7
Copy link
Contributor

CI: https://ci.nodejs.org/job/node-test-pull-request-lite/37/

@BridgeAR BridgeAR added fast-track PRs that do not need to wait for 48 hours to land. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Dec 21, 2017
@maclover7
Copy link
Contributor

Landing...

@maclover7 maclover7 self-assigned this Dec 22, 2017
@maclover7
Copy link
Contributor

Landed in 0b0a4fc, congrats on your first PR to Node.js!
❤️ 💚 💙 💛 💜

@maclover7 maclover7 closed this Dec 22, 2017
maclover7 pushed a commit that referenced this pull request Dec 22, 2017
@WaleedAshraf @maclover7
doc: removed extra explanation in api/buffer.md
0b0a4fc 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@addaleax addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 29, 2017
@WaleedAshraf
Copy link
Contributor Author

@maclover7 awesome 👍 thanks.
Can you also close the issue: #17618 ?

@maclover7
Copy link
Contributor

@WaleedAshraf Ah, my bad, that didn't make it into the final commit message. Will close out that issue.

@maclover7 maclover7 mentioned this pull request Dec 31, 2017
Closed
MylesBorins pushed a commit that referenced this pull request Jan 8, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
5cd639d 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request Jan 9, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
4db2357 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request Jan 9, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
6994559 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Jan 10, 2018
Merged
gibfahn pushed a commit that referenced this pull request Jan 24, 2018
@WaleedAshraf @gibfahn
doc: removed extra explanation in api/buffer.md
e881982 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
gibfahn pushed a commit that referenced this pull request Jan 24, 2018
@WaleedAshraf @gibfahn
doc: removed extra explanation in api/buffer.md
c291d99 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
gibfahn pushed a commit that referenced this pull request Jan 24, 2018
@WaleedAshraf @gibfahn
doc: removed extra explanation in api/buffer.md
51f2dfc 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Jan 24, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Feb 11, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
103e8c5 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request Feb 12, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
7a63c0c 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request Feb 13, 2018
@WaleedAshraf @MylesBorins
doc: removed extra explanation in api/buffer.md
1553c73 
PR-URL: #17796
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apapirovski apapirovski apapirovski approved these changes

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@cjihrig cjihrig cjihrig approved these changes

@maclover7 maclover7 maclover7 approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees

@maclover7 maclover7

Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@WaleedAshraf @apapirovski @maclover7 @jasnell @Trott @cjihrig @BridgeAR @addaleax @gibfahn @nodejs-github-bot