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

ruby-changes:70158

From: Alan <ko1@a...>
Date: Sun, 12 Dec 2021 08:45:26 +0900 (JST)
Subject: [ruby-changes:70158] 3518b00d75 (master): YJIT: Edit module documentation for clarity

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

From 3518b00d75c3efc23df1f976a8570f777fbd6ce7 Mon Sep 17 00:00:00 2001
From: Alan Wu <XrXr@u...>
Date: Sat, 11 Dec 2021 18:45:07 -0500
Subject: 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]
---
 yjit.rb | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/yjit.rb b/yjit.rb
index d06f0961fad..0bc353992c8 100644
--- a/yjit.rb
+++ b/yjit.rb
@@ -1,10 +1,13 @@ https://github.com/ruby/ruby/blob/trunk/yjit.rb#L1
-# 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?)
-- 
cgit v1.2.1


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

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