Skip to content

Commit 39effad

Browse files
st0012XrXr
authored andcommitted
[DOC] ZJIT: Add ZJIT to autolink_excluded_words
This tells RDoc to not automatically link to the `ZJIT` module so we don't need to keep escaping the word ZJIT in the documentation/comments.
1 parent 9fb34f4 commit 39effad

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

.rdoc_options

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@ autolink_excluded_words:
1919
- RDoc
2020
- Ruby
2121
- Set
22+
- ZJIT
2223

2324
canonical_root: https://docs.ruby-lang.org/en/master

zjit.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# frozen_string_literal: true
22

3-
# This module allows for introspection of \ZJIT, CRuby's just-in-time compiler.
3+
# This module allows for introspection of ZJIT, CRuby's just-in-time compiler.
44
# Everything in the module is highly implementation specific and the API might
55
# be less stable compared to the standard library.
66
#
7-
# This module may not exist if \ZJIT does not support the particular platform
7+
# This module may not exist if ZJIT does not support the particular platform
88
# for which CRuby is built.
99
module RubyVM::ZJIT
1010
# Avoid calling a Ruby method here to avoid interfering with compilation tests
@@ -14,12 +14,12 @@ module RubyVM::ZJIT
1414
end
1515

1616
class << RubyVM::ZJIT
17-
# Check if \ZJIT is enabled
17+
# Check if ZJIT is enabled
1818
def enabled?
1919
Primitive.cexpr! 'RBOOL(rb_zjit_enabled_p)'
2020
end
2121

22-
# Return \ZJIT statistics as a Hash
22+
# Return ZJIT statistics as a Hash
2323
def stats
2424
stats = Primitive.rb_zjit_stats
2525
return nil if stats.nil?
@@ -32,7 +32,7 @@ def stats
3232
stats
3333
end
3434

35-
# Get the summary of \ZJIT statistics as a String
35+
# Get the summary of ZJIT statistics as a String
3636
def stats_string
3737
buf = +''
3838
stats = self.stats

0 commit comments

Comments
 (0)