1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Clarified documentation in rb_integer_unpack [ci skip]

I struggled figuring out which of the pack/unpack functions goes into which direction and the two first sentences were of the documentation were:
* Import an integer into a buffer.
* Export an integer into a buffer.

It sounds like both of them go from a ruby integer to a buffer because both use "into". So I fixed it and went to "Import an integer from a buffer". I find this much more clear.
This commit is contained in:
Bernhard F. Brodowsky 2020-02-07 19:57:15 -05:00 committed by GitHub
parent b76a21aa45
commit 07c98537ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
Notes: git 2020-02-08 09:57:46 +09:00
Merged: https://github.com/ruby/ruby/pull/2891

Merged-By: nobu <nobu@ruby-lang.org>

View file

@ -3611,7 +3611,7 @@ rb_integer_pack(VALUE val, void *words, size_t numwords, size_t wordsize, size_t
}
/*
* Import an integer into a buffer.
* Import an integer from a buffer.
*
* [words] buffer to import.
* [numwords] the size of given buffer as number of words.