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.

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: adding example to Buffer.isBuffer method update buffer.md file #36233

Closed
wants to merge 5 commits into from
Closed

doc: adding example to Buffer.isBuffer method update buffer.md file #36233

wants to merge 5 commits into from

Conversation

ntedgi
Copy link
Contributor

@ntedgi ntedgi commented Nov 23, 2020

update buffer.md file adding example to Buffer.isBuffer method

  • documentation is changed or added
  • commit message follows

@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 Nov 23, 2020
@ntedgi
Copy link
Contributor Author

ntedgi commented Nov 23, 2020

following our conversion here at #36209 (comment)
I just update the example
@gireeshpunathil

Copy link
Member

@benjamingr benjamingr left a comment

Choose a reason for hiding this comment

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

I would make these examples much shorter probably?

Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false

@ntedgi
Copy link
Contributor Author

ntedgi commented Nov 23, 2020

I would make these examples much shorter probably?

Buffer.isBuffer(Buffer.alloc(10)); // true
Buffer.isBuffer(Buffer.from('foo')); // true
Buffer.isBuffer('a string'); // false
Buffer.isBuffer([]); // false
Buffer.isBuffer(new Uint8Array(1024)); // false

update according to your suggestions

doc/api/buffer.md Outdated Show resolved Hide resolved
doc/api/buffer.md Outdated Show resolved Hide resolved
Copy link
Member

@juanarbol juanarbol left a comment

Choose a reason for hiding this comment

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

Thank you! This is great!!

@gireeshpunathil gireeshpunathil added the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 26, 2020
@github-actions github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 26, 2020
@github-actions
Copy link
Contributor

Commit Queue failed
- Loading data for nodejs/node/pull/36233
✔  Done loading data for nodejs/node/pull/36233
----------------------------------- PR info ------------------------------------
Title      doc : adding example to Buffer.isBuffer method update buffer.md file  (#36233)
Author     Naor Tedgi (Abu Emma)  (@ntedgi, first-time contributor)
Branch     ntedgi:doc-buffer-static-method-buffer-isbuffer-obj-example -> nodejs:master
Labels     buffer, doc
Commits    5
 - doc : adding example to Buffer.isBuffer method update buffer.md file
 - remove description
 - fix linting missing semi
 - update review suggestions writing shorter tests
 - remove separat lines
Committers 1
 - naortedgi 
PR-URL: https://github.com/nodejs/node/pull/36233
Reviewed-By: Gireesh Punathil 
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Luigi Pinca 
Reviewed-By: Juan José Arboleda 
Reviewed-By: Rich Trott 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/36233
Reviewed-By: Gireesh Punathil 
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Luigi Pinca 
Reviewed-By: Juan José Arboleda 
Reviewed-By: Rich Trott 
--------------------------------------------------------------------------------
   ✔  Last GitHub Actions successful
   ℹ  Doc-only changes
   ℹ  This PR was created on Mon, 23 Nov 2020 07:39:08 GMT
   ✔  Approvals: 5
   ✔  - Gireesh Punathil (@gireeshpunathil) (TSC): https://github.com/nodejs/node/pull/36233#pullrequestreview-536237166
   ✔  - Benjamin Gruenbaum (@benjamingr): https://github.com/nodejs/node/pull/36233#pullrequestreview-536386558
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/36233#pullrequestreview-536406210
   ✔  - Juan José Arboleda (@juanarbol): https://github.com/nodejs/node/pull/36233#pullrequestreview-536476851
   ✔  - Rich Trott (@Trott) (TSC): https://github.com/nodejs/node/pull/36233#pullrequestreview-537455462
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/master up to date...
From https://github.com/nodejs/node
 * branch                  master     -> FETCH_HEAD
✔  origin/master is now up-to-date
- Downloading patch for 36233
From https://github.com/nodejs/node
 * branch                  refs/pull/36233/merge -> FETCH_HEAD
✔  Fetched commits as 4c97325c4e33..10e4d5dc21a0
--------------------------------------------------------------------------------
[master 4c0c0f00c1] doc : adding example to Buffer.isBuffer method update buffer.md file
 Author: naortedgi 
 Date: Mon Nov 23 09:34:53 2020 +0200
 1 file changed, 20 insertions(+), 1 deletion(-)
[master 58dc655de5] remove description
 Author: naortedgi 
 Date: Mon Nov 23 09:37:19 2020 +0200
 1 file changed, 1 insertion(+), 1 deletion(-)
[master 56af25f43c] fix linting missing semi
 Author: naortedgi 
 Date: Mon Nov 23 09:42:45 2020 +0200
 1 file changed, 2 insertions(+), 2 deletions(-)
[master 0a0b4a724d] update review suggestions writing shorter tests
 Author: naortedgi 
 Date: Mon Nov 23 13:05:47 2020 +0200
 1 file changed, 5 insertions(+), 15 deletions(-)
[master dd7f2e6801] remove separat lines
 Author: naortedgi 
 Date: Mon Nov 23 14:03:46 2020 +0200
 1 file changed, 2 deletions(-)
   ✔  Patches applied
There are 5 commits in the PR. Attempting autorebase.
Rebasing (2/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc : adding example to Buffer.isBuffer method update buffer.md file

PR-URL: #36233
Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com
Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Juan José Arboleda soyjuanarbol@gmail.com
Reviewed-By: Rich Trott rtrott@gmail.com

[detached HEAD c1715ee8e4] doc : adding example to Buffer.isBuffer method update buffer.md file
Author: naortedgi naor.tedgi@gmail.com
Date: Mon Nov 23 09:34:53 2020 +0200
1 file changed, 20 insertions(+), 1 deletion(-)
Rebasing (3/10)
Rebasing (4/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
remove description

PR-URL: #36233
Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com
Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Juan José Arboleda soyjuanarbol@gmail.com
Reviewed-By: Rich Trott rtrott@gmail.com

[detached HEAD a478068351] remove description
Author: naortedgi naor.tedgi@gmail.com
Date: Mon Nov 23 09:37:19 2020 +0200
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (5/10)
Rebasing (6/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
fix linting missing semi

PR-URL: #36233
Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com
Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Juan José Arboleda soyjuanarbol@gmail.com
Reviewed-By: Rich Trott rtrott@gmail.com

[detached HEAD 2351660553] fix linting missing semi
Author: naortedgi naor.tedgi@gmail.com
Date: Mon Nov 23 09:42:45 2020 +0200
1 file changed, 2 insertions(+), 2 deletions(-)
Rebasing (7/10)
Rebasing (8/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
update review suggestions writing shorter tests

PR-URL: #36233
Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com
Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Juan José Arboleda soyjuanarbol@gmail.com
Reviewed-By: Rich Trott rtrott@gmail.com

[detached HEAD cefb330868] update review suggestions writing shorter tests
Author: naortedgi naor.tedgi@gmail.com
Date: Mon Nov 23 13:05:47 2020 +0200
1 file changed, 5 insertions(+), 15 deletions(-)
Rebasing (9/10)
Rebasing (10/10)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
remove separat lines

PR-URL: #36233
Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com
Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: Juan José Arboleda soyjuanarbol@gmail.com
Reviewed-By: Rich Trott rtrott@gmail.com

[detached HEAD 081e05a2bc] remove separat lines
Author: naortedgi naor.tedgi@gmail.com
Date: Mon Nov 23 14:03:46 2020 +0200
1 file changed, 2 deletions(-)

Successfully rebased and updated refs/heads/master.
✔ c1715ee8e45305d74610d944646b4f63d46eb06d
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✔ 0:0 valid subsystems subsystem
✔ 0:0 Title is formatted correctly. title-format
⚠ 0:50 Title should be <= 50 columns. title-length
✖ a47806835142a1e9db9f43f30bde6fed6ef26fff
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✖ 0:0 Missing subsystem. subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
✖ 235166055373514da12d98008b01a0ddf51f4c4b
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✖ 0:0 Missing subsystem. subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
✖ cefb3308685e649be2d448e81a0775c307ab6a74
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✖ 0:0 Missing subsystem. subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
✖ 081e05a2bcca1b237f0bec36a30106e4b5340f03
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✖ 0:0 Missing subsystem. subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
ℹ Please fix the commit message and try again.

https://github.com/nodejs/node/actions/runs/384668227

@github-actions github-actions bot added the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Nov 26, 2020
@ntedgi ntedgi changed the title doc : adding example to Buffer.isBuffer method update buffer.md file doc: adding example to Buffer.isBuffer method update buffer.md file Nov 26, 2020
gireeshpunathil pushed a commit that referenced this pull request Nov 26, 2020
PR-URL: #36233
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
@gireeshpunathil
Copy link
Member

landed in 2b21a31 , thanks for the contribution! 🎉

danielleadams pushed a commit that referenced this pull request Dec 7, 2020
PR-URL: #36233
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
@danielleadams danielleadams mentioned this pull request Dec 7, 2020
targos pushed a commit that referenced this pull request May 1, 2021
PR-URL: #36233
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
@danielleadams danielleadams mentioned this pull request May 3, 2021
@targos targos removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Sep 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants