doc: add Buffer.from(string) to functions that use buffer pool #52801
Conversation
nodejs-github-bot
added
buffer
|
There appear to be a number of additional commits here that are unrelated to the doc change. Can I ask you to remove the extra commits? |
Whitecx
force-pushed
the
update-buffer-pool-docs
branch
from
7fdf253
to
bf02a19
Compare
Sorry about that, everything should be cleaned up now. |
|
@jasnell Does this change feel substantive? I wanted to make this PR when I had some time, because I'd used buffer.from(string) and was confused as to why the underlying buffer had other data in it. When I didn't see any explanation in the buffer.from(string) section of the docs, I actually went to the source code and found where the buffer pool was used when creating strings long before I noticed that this behavior was documented at the bottom of buffer.from(array) 😂. It would've saved me some time had it been in the buffer.from(string) section of the docs, so I thought it might help others as well. |
|
If anyone has capacity to review this PR, I'd greatly appreciate it! If it doesn't seem worth including, I can certainly close it 🙂 |
Whitecx
force-pushed
the
update-buffer-pool-docs
branch
2 times, most recently
from
95178d7
to
18263bd
Compare
Whitecx
force-pushed
the
update-buffer-pool-docs
branch
from
18263bd
to
a439e5a
Compare
|
Oh, sorry for asking one more thing but can you please change the commit message to use |
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references.
Whitecx
force-pushed
the
update-buffer-pool-docs
branch
from
a439e5a
to
214da9e
Compare
Whitecx
changed the title
No problem! I'll keep that in mind for future PRs 🙂 |
H4ad
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in ee8e841 |
|
@Whitecx congratulations on your first PR, thanks for contributing! |
Thank you!! And thank you for supporting with your review 😊 |
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references. PR-URL: #52801 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: James M Snell <jasnell@gmail.com>
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references. PR-URL: nodejs#52801 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: James M Snell <jasnell@gmail.com>
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references. PR-URL: nodejs#52801 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: James M Snell <jasnell@gmail.com>
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references. PR-URL: #52801 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: James M Snell <jasnell@gmail.com>
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references. PR-URL: #52801 Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: James M Snell <jasnell@gmail.com>
Buffer.from(string) is one of the functions that may use the pre-allocated buffer. It's mentioned in the description of Buffer.from(array), but not in Buffer.from(string), or in the two other places where functions that behave this way are listed, so this commit adds those references.