From b17e94846c87cb9d688cb4e484d0d6c3f4018b21 Mon Sep 17 00:00:00 2001 From: tompng Date: Fri, 31 Jan 2025 22:27:26 +0900 Subject: [PATCH] Escape directive-like document content --- History.rdoc | 2 +- doc/rdoc/markup_reference.rb | 2 +- lib/rdoc/parser/ruby.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/History.rdoc b/History.rdoc index deb8c77787..6a76722696 100644 --- a/History.rdoc +++ b/History.rdoc @@ -163,7 +163,7 @@ * Moved old DEVELOPERS file to CONTRIBUTING to match github conventions. * TomDoc output now has a "Returns" heading. Issue #234 by Brian Henderson * Metaprogrammed methods can now use the :args: directive in addition to the - :call-seq: directive. Issue #236 by Mike Moore. + \:call-seq: directive. Issue #236 by Mike Moore. * Sections can be linked to using "@" like labels. If a section and a label have the same name the section will be preferred. Issue #233 by Brian Henderson. diff --git a/doc/rdoc/markup_reference.rb b/doc/rdoc/markup_reference.rb index ee585b2497..6224e534bc 100644 --- a/doc/rdoc/markup_reference.rb +++ b/doc/rdoc/markup_reference.rb @@ -1245,7 +1245,7 @@ def dummy_instance_method(foo, bar); end; # # Here is the :call-seq: directive given for the method: # - # :call-seq: + # \:call-seq: # call_seq_directive(foo, bar) # Can be anything -> bar # Also anything more -> baz or bat diff --git a/lib/rdoc/parser/ruby.rb b/lib/rdoc/parser/ruby.rb index 58c54d606b..9c3dc97e90 100644 --- a/lib/rdoc/parser/ruby.rb +++ b/lib/rdoc/parser/ruby.rb @@ -120,7 +120,7 @@ # # :singleton-method: some_method! # # You can define arguments for metaprogrammed methods via either the -# :call-seq:, :arg: or :args: directives. +# \:call-seq:, :arg: or :args: directives. # # Additionally you can mark a method as an attribute by # using :attr:, :attr_reader:, :attr_writer: or :attr_accessor:. Just like