[前][次][番号順一覧][スレッド一覧]

ruby-changes:59245

From: Benoit <ko1@a...>
Date: Sat, 14 Dec 2019 20:24:51 +0900 (JST)
Subject: [ruby-changes:59245] b4b22b9278 (master): Clarify in the documentation that RubyVM::AbstractSyntaxTree is not stable API

https://git.ruby-lang.org/ruby.git/commit/?id=b4b22b9278

From b4b22b9278007b106fe40c0191f8dcf5e7e8c0f2 Mon Sep 17 00:00:00 2001
From: Benoit Daloze <eregontp@g...>
Date: Sat, 14 Dec 2019 12:16:58 +0100
Subject: Clarify in the documentation that RubyVM::AbstractSyntaxTree is not
 stable API

* See [Feature #14844].

diff --git a/ast.rb b/ast.rb
index afb8f4d..28165d8 100644
--- a/ast.rb
+++ b/ast.rb
@@ -9,6 +9,16 @@ class RubyVM https://github.com/ruby/ruby/blob/trunk/ast.rb#L9
   # This class is MRI specific as it exposes implementation details
   # of the MRI abstract syntax tree.
   #
+  # This class is experimental and its API is not stable, therefore it might
+  # change without notice. As examples, the order of children nodes is not
+  # guaranteed, the number of children nodes might change, there is no way to
+  # access children nodes by name, etc.
+  #
+  # If you are looking for a stable API or an API working under multiple Ruby
+  # implementations, consider using the +parser+ gem or Ripper. If you would
+  # like to make RubyVM::AbstractSyntaxTree stable, please join the discussion
+  # at https://bugs.ruby-lang.org/issues/14844.
+  #
   module AbstractSyntaxTree
 
     #  call-seq:
-- 
cgit v0.10.2


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]