diff options
| author | Stan Lo <stan.lo@shopify.com> | 2025-08-11 21:34:54 +0100 |
|---|---|---|
| committer | Alan Wu <XrXr@users.noreply.github.com> | 2025-08-11 18:37:51 -0400 |
| commit | 39effad4862c7cac31ad8b1dc0bdd984a3f894b6 (patch) | |
| tree | f34b0bb3610405d9770fc37e0f1533ad9cb3a5c1 | |
| parent | 9fb34f4f169736d457e3ff4d6fb4a7a596e211c6 (diff) | |
[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.
| -rw-r--r-- | .rdoc_options | 1 | ||||
| -rw-r--r-- | zjit.rb | 10 |
2 files changed, 6 insertions, 5 deletions
diff --git a/.rdoc_options b/.rdoc_options index 02cf1f00d8..76c1c8e0db 100644 --- a/.rdoc_options +++ b/.rdoc_options @@ -19,5 +19,6 @@ autolink_excluded_words: - RDoc - Ruby - Set +- ZJIT canonical_root: https://docs.ruby-lang.org/en/master @@ -1,10 +1,10 @@ # frozen_string_literal: true -# This module allows for introspection of \ZJIT, CRuby's just-in-time compiler. +# This module allows for introspection of ZJIT, CRuby's just-in-time compiler. # Everything in the module is highly implementation specific and the API might # be less stable compared to the standard library. # -# This module may not exist if \ZJIT does not support the particular platform +# This module may not exist if ZJIT does not support the particular platform # for which CRuby is built. module RubyVM::ZJIT # Avoid calling a Ruby method here to avoid interfering with compilation tests @@ -14,12 +14,12 @@ module RubyVM::ZJIT end class << RubyVM::ZJIT - # Check if \ZJIT is enabled + # Check if ZJIT is enabled def enabled? Primitive.cexpr! 'RBOOL(rb_zjit_enabled_p)' end - # Return \ZJIT statistics as a Hash + # Return ZJIT statistics as a Hash def stats stats = Primitive.rb_zjit_stats return nil if stats.nil? @@ -32,7 +32,7 @@ class << RubyVM::ZJIT stats end - # Get the summary of \ZJIT statistics as a String + # Get the summary of ZJIT statistics as a String def stats_string buf = +'' stats = self.stats |