Skip to content

Commit 4da569b

Browse files
st0012XrXr
authored andcommitted
[DOC] YJIT: Add YJIT to autolink_excluded_words
1 parent 39effad commit 4da569b

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
@@ -20,5 +20,6 @@ autolink_excluded_words:
2020
- Ruby
2121
- Set
2222
- ZJIT
23+
- YJIT
2324

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

yjit.rb

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

4-
# This module allows for introspection of \YJIT, CRuby's just-in-time compiler.
4+
# This module allows for introspection of YJIT, CRuby's just-in-time compiler.
55
# Everything in the module is highly implementation specific and the API might
66
# be less stable compared to the standard library.
77
#
8-
# This module may not exist if \YJIT does not support the particular platform
8+
# This module may not exist if YJIT does not support the particular platform
99
# for which CRuby is built.
1010
module RubyVM::YJIT
11-
# Check if \YJIT is enabled.
11+
# Check if YJIT is enabled.
1212
def self.enabled?
1313
Primitive.cexpr! 'RBOOL(rb_yjit_enabled_p)'
1414
end
@@ -33,8 +33,8 @@ def self.reset_stats!
3333
Primitive.rb_yjit_reset_stats_bang
3434
end
3535

36-
# Enable \YJIT compilation. `stats` option decides whether to enable \YJIT stats or not. `log` decides
37-
# whether to enable \YJIT compilation logging or not. Optional `mem_size` and `call_threshold` can be
36+
# Enable YJIT compilation. `stats` option decides whether to enable YJIT stats or not. `log` decides
37+
# whether to enable YJIT compilation logging or not. Optional `mem_size` and `call_threshold` can be
3838
# provided to override default configuration.
3939
#
4040
# * `stats`:

0 commit comments

Comments
 (0)