[前][次][番号順一覧][スレッド一覧]

ruby-changes:66931

From: Olle <ko1@a...>
Date: Wed, 28 Jul 2021 13:35:20 +0900 (JST)
Subject: [ruby-changes:66931] 0663134ad1 (master): [ruby/getoptlong] RDoc: escape to avoid links to the word Set

https://git.ruby-lang.org/ruby.git/commit/?id=0663134ad1

From 0663134ad115e6ba67913555c558392edfc57205 Mon Sep 17 00:00:00 2001
From: Olle Jonsson <olle.jonsson@a...>
Date: Thu, 3 Jun 2021 15:10:28 +0200
Subject: [ruby/getoptlong] RDoc: escape to avoid links to the word Set

We would like to avoid linking to the Set class for these words.

https://github.com/ruby/getoptlong/commit/33b56d6141
---
 lib/getoptlong.rb | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/lib/getoptlong.rb b/lib/getoptlong.rb
index 53b80ff..d3fff34 100644
--- a/lib/getoptlong.rb
+++ b/lib/getoptlong.rb
@@ -114,7 +114,7 @@ class GetoptLong https://github.com/ruby/ruby/blob/trunk/lib/getoptlong.rb#L114
   class InvalidOption    < Error; end
 
   #
-  # Set up option processing.
+  # \Set up option processing.
   #
   # The options to support are passed to new() as an array of arrays.
   # Each sub-array contains any number of String option names which carry
@@ -190,7 +190,7 @@ class GetoptLong https://github.com/ruby/ruby/blob/trunk/lib/getoptlong.rb#L190
   end
 
   #
-  # Set the handling of the ordering of options and arguments.
+  # \Set the handling of the ordering of options and arguments.
   # A RuntimeError is raised if option processing has already started.
   #
   # The supplied value must be a member of GetoptLong::ORDERINGS. It alters
@@ -267,7 +267,7 @@ class GetoptLong https://github.com/ruby/ruby/blob/trunk/lib/getoptlong.rb#L267
   attr_reader :ordering
 
   #
-  # Set options. Takes the same argument as GetoptLong.new.
+  # \Set options. Takes the same argument as GetoptLong.new.
   #
   # Raises a RuntimeError if option processing has already started.
   #
@@ -341,7 +341,7 @@ class GetoptLong https://github.com/ruby/ruby/blob/trunk/lib/getoptlong.rb#L341
   end
 
   #
-  # Set/Unset `quiet' mode.
+  # \Set/Unset `quiet' mode.
   #
   attr_writer :quiet
 
@@ -383,7 +383,7 @@ class GetoptLong https://github.com/ruby/ruby/blob/trunk/lib/getoptlong.rb#L383
   end
 
   #
-  # Set an error (a protected method).
+  # \Set an error (a protected method).
   #
   def set_error(type, message)
     $stderr.print("#{$0}: #{message}\n") if !@quiet
-- 
cgit v1.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]