Skip to content

Commit

Permalink
YJIT: Edit module documentation for clarity
Browse files Browse the repository at this point in the history
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 c10d508.

[ci skip]
  • Loading branch information
XrXr committed Dec 11, 2021
1 parent d7ef372 commit 3518b00
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions yjit.rb
Original file line number Diff line number Diff line change
@@ -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?)
Expand Down

0 comments on commit 3518b00

Please sign in to comment.