Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

doc: document AliasedBuffer in C++ style guide #22977

Closed
joyeecheung opened this issue Sep 20, 2018 · 1 comment
Closed

doc: document AliasedBuffer in C++ style guide #22977

joyeecheung opened this issue Sep 20, 2018 · 1 comment
Labels
doc Issues and PRs related to the documentations.

Comments

@joyeecheung
Copy link
Member

The actual API is documented in https://github.com/nodejs/node/blob/master/src/aliased_buffer.h but it would be good to have a note in the style guide about trying not to create regular typed arrays in C++ if they are going to be used to pass data out of band.
@joyeecheung joyeecheung added the doc Issues and PRs related to the documentations. label Sep 20, 2018
@gireeshpunathil gireeshpunathil mentioned this issue Nov 29, 2018
Closed
4 tasks
gireeshpunathil added a commit to gireeshpunathil/node that referenced this issue Dec 2, 2018
@gireeshpunathil
doc: add a note on usage scope of AliasedBuffer
1917213 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: nodejs#22977
@Trott
Copy link
Member

Trott commented Dec 4, 2018

Fixed in 447b390

@Trott Trott closed this as completed Dec 4, 2018
Trott pushed a commit to Trott/io.js that referenced this issue Dec 4, 2018
@gireeshpunathil @Trott
doc: add a note on usage scope of AliasedBuffer
447b390 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: nodejs#22977

PR-URL: nodejs#24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
BridgeAR pushed a commit that referenced this issue Dec 5, 2018
@gireeshpunathil @BridgeAR
doc: add a note on usage scope of AliasedBuffer
3d1853b 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: #22977

PR-URL: #24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
refack pushed a commit to refack/node that referenced this issue Jan 14, 2019
@gireeshpunathil @refack
doc: add a note on usage scope of AliasedBuffer
654a0c9 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: nodejs#22977

PR-URL: nodejs#24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
BethGriggs pushed a commit that referenced this issue Feb 12, 2019
@gireeshpunathil @BethGriggs
doc: add a note on usage scope of AliasedBuffer
7bd7328 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: #22977

PR-URL: #24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
BethGriggs pushed a commit that referenced this issue Feb 20, 2019
@gireeshpunathil @BethGriggs
doc: add a note on usage scope of AliasedBuffer
4f71fa1 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: #22977

PR-URL: #24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
rvagg pushed a commit that referenced this issue Feb 28, 2019
@gireeshpunathil @rvagg
doc: add a note on usage scope of AliasedBuffer
daaf3a4 
Explain usage context and scope of AliasedBuffer API and its
function in the C++ style guide. Provide an example code.

Fixes: #22977

PR-URL: #24724
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: document AliasedBuffers usage scope in style guide gireeshpunathil/node
2 participants
@Trott @joyeecheung