summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBernhard F. Brodowsky <bernhard.brodowsky@gmail.com>2020-02-07 19:57:15 -0500
committerGitHub <noreply@github.com>2020-02-08 09:57:15 +0900
commit07c98537cae5c88cff0496fb8ef985771218fe1f (patch)
treecebb8f5f94422fa63e63e8d53e3b2cf427829673
parentb76a21aa45fff75909a66f8b20fc5856705f7862 (diff)
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.
Notes
Notes: Merged: https://github.com/ruby/ruby/pull/2891 Merged-By: nobu <nobu@ruby-lang.org>
-rw-r--r--bignum.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/bignum.c b/bignum.c
index 78c5681508e..e9bb5780b5c 100644
--- a/bignum.c
+++ b/bignum.c
@@ -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.