summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2020-07-26 13:56:26 +0900
committerGitHub <[email protected]>2020-07-26 13:56:26 +0900
commit9571a4c07e014444d6a986f6dbe8a5de908a065f (patch)
tree29ce4001e675239764e78e5bbe0bea24e82f0ad0
parent425b5f32d6f4433c759663c2dad797a9d0769266 (diff)
parent0983c723c51cba5f603e374383d105443abf75a9 (diff)
downloadmruby-9571a4c07e014444d6a986f6dbe8a5de908a065f.tar.gz
mruby-9571a4c07e014444d6a986f6dbe8a5de908a065f.zip
Merge pull request #5050 from dearblue/memsize_of2
Update document for `ObjectSpace.memsize_of` [ci skip]
-rw-r--r--mrbgems/mruby-os-memsize/src/memsize.c8
1 files changed, 1 insertions, 7 deletions
diff --git a/mrbgems/mruby-os-memsize/src/memsize.c b/mrbgems/mruby-os-memsize/src/memsize.c
index 14f90109d..65020c97f 100644
--- a/mrbgems/mruby-os-memsize/src/memsize.c
+++ b/mrbgems/mruby-os-memsize/src/memsize.c
@@ -162,7 +162,7 @@ os_memsize_of_object(mrb_state* mrb, mrb_value obj)
/*
* call-seq:
- * ObjectSpace.memsize_of(obj, recurse: false) -> Numeric
+ * ObjectSpace.memsize_of(obj) -> Numeric
*
* Returns the amount of heap memory allocated for object in size_t units.
*
@@ -173,12 +173,6 @@ os_memsize_of_object(mrb_state* mrb, mrb_value obj)
* return 0. Additionally special objects which are small enough to fit inside an
* object pointer, termed embedded objects, will return the size of the object pointer.
* Strings and arrays below a compile-time defined size may be embedded.
- *
- * Setting recurse: true descends into instance variables, array members,
- * hash keys and hash values recursively, calculating the child objects and adding to
- * the final sum. It avoids infinite recursion and over counting objects by
- * internally tracking discovered object ids.
- *
*/
static mrb_value