summaryrefslogtreecommitdiff
path: root/iseq.c
diff options
context:
space:
mode:
authorJeremy Evans <code@jeremyevans.net>2019-07-14 19:39:57 -0700
committerJeremy Evans <code@jeremyevans.net>2019-08-05 16:14:30 -0700
commit96cec6b27741cbdeb51ea3acdeba0e813d51035f (patch)
treeda8020e9eb08723a140c3ecd91cad0f5ae589e1d /iseq.c
parent2b6441196ef32d93c7898764610a913f54f8bc32 (diff)
Document that RubyVM::InstructionSequence methods are implementation and version dependent
Fixes [Bug #6785]
Diffstat (limited to 'iseq.c')
-rw-r--r--iseq.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/iseq.c b/iseq.c
index 776576a52b..418d273012 100644
--- a/iseq.c
+++ b/iseq.c
@@ -3456,7 +3456,9 @@ succ_index_lookup(const struct succ_index_table *sd, int x)
* Document-class: RubyVM::InstructionSequence
*
* The InstructionSequence class represents a compiled sequence of
- * instructions for the Ruby Virtual Machine.
+ * instructions for the Ruby Virtual Machine. Not all implementations of Ruby
+ * may implement this class, and for the implementations that implement it,
+ * the methods defined and behavior of the methods can change in any version.
*
* With it, you can get a handle to the instructions that make up a method or
* a proc, compile strings of Ruby code down to VM instructions, and