summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Wu <alanwu@ruby-lang.org>2020-08-02 12:56:06 -0400
committerAlan Wu <alanwu@ruby-lang.org>2020-08-02 12:56:06 -0400
commitc987be2552d69eca3da7980e5edb3c11eced4b2f (patch)
tree50b67ed46372784072f79da7956fdaeee7dce7bd
parentac69849e49982ea83036c04c5d5f7245e3956a49 (diff)
Improve docs for Module#remove_class_variable [ci skip]
-rw-r--r--variable.c9
1 files changed, 4 insertions, 5 deletions
diff --git a/variable.c b/variable.c
index fe55cc9501..56340820f3 100644
--- a/variable.c
+++ b/variable.c
@@ -3328,13 +3328,12 @@ rb_mod_class_variables(int argc, const VALUE *argv, VALUE mod)
* call-seq:
* remove_class_variable(sym) -> obj
*
- * Removes the definition of the <i>sym</i>, returning that
- * constant's value.
+ * Removes the named class variable from the receiver, returning that
+ * variable's value.
*
- * class Dummy
+ * class Example
* @@var = 99
- * puts @@var
- * remove_class_variable(:@@var)
+ * puts remove_class_variable(:@@var)
* p(defined? @@var)
* end
*