aboutsummaryrefslogtreecommitdiffstats
path: root/ast.c
diff options
context:
space:
mode:
authorBenoit Daloze <eregontp@gmail.com>2019-08-19 13:51:00 +0800
committerTakashi Kokubun <takashikkbn@gmail.com>2019-08-19 14:51:00 +0900
commit39a43d9cd09f8c880d0a70d9cb8ede6d7e6ef583 (patch)
tree42cd014a8d4b57ba791255bbdd678828942646cf /ast.c
parentd76be10df11cf24d7a5a1f88a4aadc6d817db4a7 (diff)
downloadruby-39a43d9cd09f8c880d0a70d9cb8ede6d7e6ef583.tar.gz
Make it as clear as possible that RubyVM is MRI-specific and only exists on MRI (#2113) [ci skip]
* Make it clear as possible that RubyVM is MRI-specific and only exists on MRI * See [Bug #15743]. * Use "CRuby VM" instead of "Ruby VM" for clarity. * Use YARV rather than "CRuby VM" for documenting RubyVM::InstructionSequence * Avoid introducing a new "CRuby VM" term in documentation
Diffstat (limited to 'ast.c')
-rw-r--r--ast.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/ast.c b/ast.c
index 4c6477d3c9..91659a9110 100644
--- a/ast.c
+++ b/ast.c
@@ -776,11 +776,16 @@ Init_ast(void)
* AbstractSyntaxTree provides methods to parse Ruby code into
* abstract syntax trees. The nodes in the tree
* are instances of RubyVM::AbstractSyntaxTree::Node.
+ *
+ * This class is MRI specific as it exposes implementation details
+ * of the MRI abstract syntax tree.
*/
rb_mAST = rb_define_module_under(rb_cRubyVM, "AbstractSyntaxTree");
/*
* RubyVM::AbstractSyntaxTree::Node instances are created by parse methods in
* RubyVM::AbstractSyntaxTree.
+ *
+ * This class is MRI specific.
*/
rb_cNode = rb_define_class_under(rb_mAST, "Node", rb_cObject);