summaryrefslogtreecommitdiff
path: root/yjit.rb
diff options
context:
space:
mode:
authorAlan Wu <XrXr@users.noreply.github.com>2021-12-11 18:45:07 -0500
committerGitHub <noreply@github.com>2021-12-11 18:45:07 -0500
commit3518b00d75c3efc23df1f976a8570f777fbd6ce7 (patch)
treecd1b44e0849a68fc088e46a3342594287d4176df /yjit.rb
parentd7ef372c9512b600a50d524e6b0b1cffc82933c1 (diff)
downloadruby-3518b00d75c3efc23df1f976a8570f777fbd6ce7.tar.gz
YJIT: Edit module documentation for clarity
Add an empty line before the module doc string so RDoc can find it. While we are at it, edit for clarity. The file should already be using frozen string literals since c10d5085a247266c6399dc6fb68706d87cbdab05. [ci skip]
Diffstat (limited to 'yjit.rb')
-rw-r--r--yjit.rb13
1 files changed, 8 insertions, 5 deletions
diff --git a/yjit.rb b/yjit.rb
index d06f0961fa..0bc353992c 100644
--- a/yjit.rb
+++ b/yjit.rb
@@ -1,10 +1,13 @@
-# This module allows for introspection on YJIT, CRuby's experimental in-process
-# just-in-time compiler. This module is for development purposes only;
-# everything in this module is highly implementation specific and comes with no
+# frozen_string_literal: true
+
+# This module allows for introspection of YJIT, CRuby's experimental in-process
+# just-in-time compiler. This module exists only to help develop YJIT, as such,
+# everything in the module is highly implementation specific and comes with no
# API stability guarantee whatsoever.
#
-# This module is only defined when YJIT has support for the particular platform
-# on which CRuby is built.
+# This module may not exist if YJIT does not support the particular platform
+# for which CRuby is built. There is also no API stability guarantee as to in
+# what situations this module is defined.
module RubyVM::YJIT
if defined?(Disasm)
def self.disasm(iseq, tty: $stdout && $stdout.tty?)