test-unit 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb10c0d7af194e24435b053a461586ada42c4e4e42d041501c2911780174923
-  data.tar.gz: 612e5265d004a19a939f8c46e66ef827c226d6bf6e891d69b0519ab4cf73ac96
+  metadata.gz: 8559bf050780c83fa9e6ff438ac369f279e108300637b4f91766bf16e074b95a
+  data.tar.gz: 250688e7308d7a22110bce25ce3e171fa0dd0cc9d2da828522b8ccefb30ec94e
 SHA512:
-  metadata.gz: fad23c31ae8c91bd9b93669dda077068e987d5dabb5f6ad554d659dc17c5706354d9ef9795a3130fa1a055416cb67355af81c376246ca991990d6e4defd90c49
-  data.tar.gz: 30f78ce8f9a5cfa58936f98354758bb9761f845c1cbeb26665f5b6d4edc0494cc8adb0e0a7ccbe85106affc43d267423088015a134d5afd85c05c1ce79038f1b
+  metadata.gz: 19e0050adf3340836e1591632b001ac69c995497b37a55eb741d17a469f43d78e4b7160fc030b063ad334d79ea4ad904cadc219ffa6bed8324e3bc3cb83cb83e
+  data.tar.gz: 6e2e87365ac089e6ee0d6ec168340384510be4c6f228f14092b5231731c0a9856077071eff267dd02dd9f81d188391d3a9e2bd29920b351849f786476b333774

data/doc/text/news.md

@@ -1,5 +1,21 @@
 # News
 
+## 3.3.4 - 2019-09-30 {#version-3-3-4}
+
+### Improvements
+
+  * Converted markup format to Markdown from RDoc.
+    [GitHub#164][Patch by OGAWA KenIchi]
+
+  * test: Stopped to depend on `Time#inspect` format.
+    [GitHub#165][Reported by Benoit Daloze]
+
+### Thanks
+
+  * OGAWA KenIchi
+
+  * Benoit Daloze
+
 ## 3.3.3 - 2019-05-10 {#version-3-3-3}
 
 ### Fixed

data/lib/test/unit.rb

@@ -3,9 +3,9 @@ require 'test/unit/autorunner'
 
 module Test # :nodoc:
   #
-  # = Test::Unit - Ruby Unit Testing Framework
+  # # Test::Unit - Ruby Unit Testing Framework
   # 
-  # == Introduction
+  # ## Introduction
   # 
   # Unit testing is making waves all over the place, largely due to the
   # fact that it is a core practice of XP. While XP is great, unit testing
@@ -24,12 +24,12 @@ module Test # :nodoc:
   # have tests for it.
   # 
   # 
-  # == Notes
+  # ## Notes
   # 
   # Test::Unit has grown out of and superceded Lapidary.
   # 
   # 
-  # == Feedback
+  # ## Feedback
   # 
   # I like (and do my best to practice) XP, so I value early releases,
   # user feedback, and clean, simple, expressive code. There is always
@@ -43,7 +43,7 @@ module Test # :nodoc:
   # info is below.
   # 
   # 
-  # == Contact Information
+  # ## Contact Information
   # 
   # A lot of discussion happens about Ruby in general on the ruby-talk
   # mailing list (http://www.ruby-lang.org/en/ml.html), and you can ask
@@ -53,7 +53,7 @@ module Test # :nodoc:
   # at mailto:testunit@talbott.ws, and I'll do my best to help you out.
   # 
   # 
-  # == Credits
+  # ## Credits
   # 
   # I'd like to thank...
   # 
@@ -86,7 +86,7 @@ module Test # :nodoc:
   # My Creator, for giving me life, and giving it more abundantly.
   # 
   # 
-  # == License
+  # ## License
   # 
   # Test::Unit is copyright (c) 2000-2003 Nathaniel Talbott. It is free
   # software, and is distributed under the Ruby license. See the COPYING
@@ -98,7 +98,7 @@ module Test # :nodoc:
   # under the Ruby license and/or the PSF license. See the
   # COPYING file and PSFL file.
   # 
-  # == Warranty
+  # ## Warranty
   # 
   # This software is provided "as is" and without any express or
   # implied warranties, including, without limitation, the implied
@@ -106,14 +106,14 @@ module Test # :nodoc:
   # purpose.
   # 
   # 
-  # == Author
+  # ## Author
   # 
   # Nathaniel Talbott.
   # Copyright (c) 2000-2003, Nathaniel Talbott
   #
   # ----
   #
-  # = Usage
+  # # Usage
   #
   # The general idea behind unit testing is that you write a _test_
   # _method_ that makes certain _assertions_ about your code, working
@@ -125,7 +125,7 @@ module Test # :nodoc:
   # pieces.
   #
   #
-  # == Assertions
+  # ## Assertions
   #
   # These are the heart of the framework. Think of an assertion as a
   # statement of expected outcome, i.e. "I assert that x should be equal
@@ -137,7 +137,7 @@ module Test # :nodoc:
   # of the current assertions, see Test::Unit::Assertions.
   #
   #
-  # == Test Method & Test Fixture
+  # ## Test Method & Test Fixture
   #
   # Obviously, these assertions have to be called within a context that
   # knows about them and can do something meaningful with their
@@ -197,7 +197,7 @@ module Test # :nodoc:
   #     end
   #
   #
-  # == Test Runners
+  # ## Test Runners
   #
   # So, now you have this great test class, but you still
   # need a way to run it and view any failures that occur
@@ -208,10 +208,10 @@ module Test # :nodoc:
   # runner simply set default test runner ID to
   # Test::Unit::AutoRunner:
   #
-  #    require 'test/unit'
-  #    Test::Unit::AutoRunner.default_runner = "gtk2"
+  #     require 'test/unit'
+  #     Test::Unit::AutoRunner.default_runner = "gtk2"
   #
-  # == Test Suite
+  # ## Test Suite
   #
   # As more and more unit tests accumulate for a given project, it
   # becomes a real drag running them one at a time, and it also
@@ -228,17 +228,17 @@ module Test # :nodoc:
   # 'test/unit'. What does this mean? It means you could
   # write the above test case like this instead:
   #
-  #  require 'test/unit'
-  #  require 'test_myfirsttests'
-  #  require 'test_moretestsbyme'
-  #  require 'test_anothersetoftests'
+  #     require 'test/unit'
+  #     require 'test_myfirsttests'
+  #     require 'test_moretestsbyme'
+  #     require 'test_anothersetoftests'
   #
   # Test::Unit is smart enough to find all the test cases existing in
   # the ObjectSpace and wrap them up into a suite for you. It then runs
   # the dynamic suite using the console TestRunner.
   #
   #
-  # == Configuration file
+  # ## Configuration file
   #
   # Test::Unit reads 'test-unit.yml' in the current working
   # directory as Test::Unit's configuration file. It can
@@ -254,53 +254,58 @@ module Test # :nodoc:
   #
   # Here are sample color scheme definitions:
   #
-  #   color_schemes:
-  #     inverted:
-  #       success:
-  #         name: red
-  #         bold: true
-  #       failure:
-  #         name: green
-  #         bold: true
-  #     other_scheme:
-  #       ...
+  #     color_schemes:
+  #       inverted:
+  #         success:
+  #           name: red
+  #           bold: true
+  #         failure:
+  #           name: green
+  #           bold: true
+  #       other_scheme:
+  #         ...
   #
   # Here are the syntax of color scheme definitions:
   #
-  #  color_schemes:
-  #    SCHEME_NAME:
-  #      EVENT_NAME:
-  #        name: COLOR_NAME
-  #        intensity: BOOLEAN
-  #        bold: BOOLEAN
-  #        italic: BOOLEAN
-  #        underline: BOOLEAN
-  #      ...
-  #    ...
-  #
-  # SCHEME_NAME:: the name of the color scheme
-  # EVENT_NAME:: one of [success, failure, pending,
-  #              omission, notification, error]
-  # COLOR_NAME:: one of [black, red, green, yellow, blue,
-  #              magenta, cyan, white]
-  # BOOLEAN:: true or false
+  #     color_schemes:
+  #       SCHEME_NAME:
+  #         EVENT_NAME:
+  #           name: COLOR_NAME
+  #           intensity: BOOLEAN
+  #           bold: BOOLEAN
+  #           italic: BOOLEAN
+  #           underline: BOOLEAN
+  #         ...
+  #       ...
+  #
+  # SCHEME_NAME
+  # : the name of the color scheme
+  #
+  # EVENT_NAME
+  # : one of [success, failure, pending, omission, notification, error]
+  #
+  # COLOR_NAME
+  # : one of [black, red, green, yellow, blue, magenta, cyan, white]
+  #
+  # BOOLEAN
+  # : true or false
   #
   # You can use the above 'inverted' color scheme with the
   # following configuration:
   #
-  #   runner: console
-  #   console_options:
-  #     color_scheme: inverted
-  #   color_schemes:
-  #     inverted:
-  #       success:
-  #         name: red
-  #         bold: true
-  #       failure:
-  #         name: green
-  #         bold: true
+  #     runner: console
+  #     console_options:
+  #       color_scheme: inverted
+  #     color_schemes:
+  #       inverted:
+  #         success:
+  #           name: red
+  #           bold: true
+  #         failure:
+  #           name: green
+  #           bold: true
   #
-  # == Questions?
+  # ## Questions?
   #
   # I'd really like to get feedback from all levels of Ruby
   # practitioners about typos, grammatical errors, unclear statements,
@@ -331,51 +336,53 @@ module Test # :nodoc:
       # To register multiple hooks, call this method multiple times.
       #
       # Here is an example test case:
-      #   Test::Unit.at_start do
-      #     # ...
-      #   end
-      #
-      #   class TestMyClass1 < Test::Unit::TestCase
-      #     class << self
-      #       def startup
-      #         # ...
-      #       end
-      #     end
       #
-      #     def setup
+      #     Test::Unit.at_start do
       #       # ...
       #     end
       #
-      #     def test_my_class1
-      #       # ...
-      #     end
+      #     class TestMyClass1 < Test::Unit::TestCase
+      #       class << self
+      #         def startup
+      #           # ...
+      #         end
+      #       end
       #
-      #     def test_my_class2
-      #       # ...
-      #     end
-      #   end
+      #       def setup
+      #         # ...
+      #       end
       #
-      #   class TestMyClass2 < Test::Unit::TestCase
-      #     class << self
-      #       def startup
+      #       def test_my_class1
       #         # ...
       #       end
-      #     end
       #
-      #     def setup
-      #       # ...
+      #       def test_my_class2
+      #         # ...
+      #       end
       #     end
       #
-      #     def test_my_class1
-      #       # ...
-      #     end
+      #     class TestMyClass2 < Test::Unit::TestCase
+      #       class << self
+      #         def startup
+      #           # ...
+      #         end
+      #       end
       #
-      #     def test_my_class2
-      #       # ...
+      #       def setup
+      #         # ...
+      #       end
+      #
+      #       def test_my_class1
+      #         # ...
+      #       end
+      #
+      #       def test_my_class2
+      #         # ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * at_start
       # * TestMyClass1.startup
       # * TestMyClass1#setup
@@ -415,51 +422,53 @@ module Test # :nodoc:
       # To register multiple hooks, call this method multiple times.
       #
       # Here is an example test case:
-      #   Test::Unit.at_exit do
-      #     # ...
-      #   end
-      #
-      #   class TestMyClass1 < Test::Unit::TestCase
-      #     class << self
-      #       def shutdown
-      #         # ...
-      #       end
-      #     end
       #
-      #     def teardown
+      #     Test::Unit.at_exit do
       #       # ...
       #     end
       #
-      #     def test_my_class1
-      #       # ...
-      #     end
+      #     class TestMyClass1 < Test::Unit::TestCase
+      #       class << self
+      #         def shutdown
+      #           # ...
+      #         end
+      #       end
       #
-      #     def test_my_class2
-      #       # ...
-      #     end
-      #   end
+      #       def teardown
+      #         # ...
+      #       end
       #
-      #   class TestMyClass2 < Test::Unit::TestCase
-      #     class << self
-      #       def shutdown
+      #       def test_my_class1
       #         # ...
       #       end
-      #     end
       #
-      #     def teardown
-      #       # ...
+      #       def test_my_class2
+      #         # ...
+      #       end
       #     end
       #
-      #     def test_my_class1
-      #       # ...
-      #     end
+      #     class TestMyClass2 < Test::Unit::TestCase
+      #       class << self
+      #         def shutdown
+      #           # ...
+      #         end
+      #       end
       #
-      #     def test_my_class2
-      #       # ...
+      #       def teardown
+      #         # ...
+      #       end
+      #
+      #       def test_my_class1
+      #         # ...
+      #       end
+      #
+      #       def test_my_class2
+      #         # ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * TestMyClass1#test_my_class1
       # * TestMyClass1#teardown
       # * TestMyClass1#test_my_class2

data/lib/test/unit/assertions.rb

@@ -171,7 +171,7 @@ module Test
         end
       end
 
-      # Asserts that +object+ is false or nil.
+      # Asserts that `object` is false or nil.
       #
       # @note Just for minitest compatibility. :<
       #
@@ -213,7 +213,7 @@ module Test
       end
 
       ##
-      # Passes if +expected+ == +actual+.
+      # Passes if `expected` == `actual`.
       #
       # Note that the ordering of arguments is important, since a helpful
       # error message is generated when this one fails that tells you the
@@ -314,7 +314,7 @@ EOT
 
 
       ##
-      # Passes if +object+.instance_of?(+klass+). When +klass+ is
+      # Passes if `object`.instance_of?(`klass`). When `klass` is
       # an array of classes, it passes if any class
       # satisfies +object.instance_of?(class).
       #
@@ -348,8 +348,8 @@ EOT
       end
 
       ##
-      # Passes if +object+.instance_of?(+klass+) does not hold.
-      # When +klass+ is an array of classes, it passes if no class
+      # Passes if `object`.instance_of?(`klass`) does not hold.
+      # When `klass` is an array of classes, it passes if no class
       # satisfies +object.instance_of?(class).
       #
       # @example
@@ -389,7 +389,7 @@ EOT
       alias_method :refute_instance_of, :assert_not_instance_of
 
       ##
-      # Passes if +object+ is nil.
+      # Passes if `object` is nil.
       #
       # @example
       #   assert_nil [1, 2].uniq!
@@ -401,7 +401,7 @@ EOT
       end
 
       ##
-      # Passes if +object+.kind_of?(+klass+). When +klass+ is
+      # Passes if `object`.kind_of?(`klass`). When `klass` is
       # an array of classes or modules, it passes if any
       # class or module satisfies +object.kind_of?(class_or_module).
       #
@@ -437,8 +437,8 @@ EOT
       end
 
       ##
-      # Passes if +object+.kind_of?(+klass+) does not hold.
-      # When +klass+ is an array of classes or modules, it passes only if all
+      # Passes if `object`.kind_of?(`klass`) does not hold.
+      # When `klass` is an array of classes or modules, it passes only if all
       # classes (and modules) do not satisfy +object.kind_of?(class_or_module).
       #
       # @example
@@ -478,7 +478,7 @@ EOT
       alias_method :refute_kind_of, :assert_not_kind_of
 
       ##
-      # Passes if +object+ .respond_to? +method+
+      # Passes if `object` .respond_to? `method`
       #
       # @example
       #   assert_respond_to 'bugbear', :slice
@@ -500,7 +500,7 @@ EOT
       end
 
       ##
-      # Passes if +object+ does not .respond_to? +method+.
+      # Passes if `object` does not .respond_to? `method`.
       #
       # @example
       #   assert_not_respond_to('bugbear', :nonexistence) # -> pass
@@ -528,7 +528,7 @@ EOT
       alias_method :refute_respond_to, :assert_not_respond_to
 
       ##
-      # Passes if +pattern+ =~ +string+.
+      # Passes if `pattern` =~ `string`.
       #
       # @example
       #   assert_match(/\d+/, 'five, 6, seven')
@@ -548,7 +548,7 @@ EOT
       end
 
       ##
-      # Passes if +actual+ .equal? +expected+ (i.e. they are the same
+      # Passes if `actual` .equal? `expected` (i.e. they are the same
       # instance).
       #
       # @example
@@ -565,7 +565,7 @@ EOT
       end
 
       ##
-      # Compares the +object1+ with +object2+ using +operator+.
+      # Compares the `object1` with `object2` using `operator`.
       #
       # Passes if object1.__send__(operator, object2) is true.
       #
@@ -585,7 +585,7 @@ EOT
       end
 
       ##
-      # Compares the +object1+ with +object2+ using +operator+.
+      # Compares the `object1` with `object2` using `operator`.
       #
       # Passes if object1.__send__(operator, object2) is not true.
       #
@@ -652,7 +652,7 @@ EOT
       end
 
       ##
-      # Passes if ! +actual+ .equal? +expected+
+      # Passes if ! `actual` .equal? `expected`
       #
       # @example
       #   assert_not_same Object.new, Object.new
@@ -672,7 +672,7 @@ EOT
       alias_method :refute_same, :assert_not_same
 
       ##
-      # Passes if +expected+ != +actual+
+      # Passes if `expected` != `actual`
       #
       # @example
       #   assert_not_equal 'some string', 5
@@ -689,7 +689,7 @@ EOT
       alias_method :refute_equal, :assert_not_equal
 
       ##
-      # Passes if ! +object+ .nil?
+      # Passes if ! `object` .nil?
       #
       # @example
       #   assert_not_nil '1 two 3'.sub!(/two/, '2')
@@ -706,7 +706,7 @@ EOT
       alias_method :refute_nil, :assert_not_nil
 
       ##
-      # Passes if +regexp+ !~ +string+
+      # Passes if `regexp` !~ `string`
       #
       # @example
       #   assert_not_match(/two/, 'one 2 three')   # -> pass
@@ -731,7 +731,7 @@ EOT
       ##
       # Deprecated. Use #assert_not_match instead.
       #
-      # Passes if +regexp+ !~ +string+
+      # Passes if `regexp` !~ `string`
       #
       # @example
       #   assert_no_match(/two/, 'one 2 three')   # -> pass
@@ -789,7 +789,7 @@ EOT
       end
 
       ##
-      # Passes if the block throws +expected_object+
+      # Passes if the block throws `expected_object`
       #
       # @example
       #   assert_throw(:done) do
@@ -860,8 +860,8 @@ EOT
       end
 
       ##
-      # Passes if +expected_float+ and +actual_float+ are equal
-      # within +delta+ tolerance.
+      # Passes if `expected_float` and `actual_float` are equal
+      # within `delta` tolerance.
       #
       # @example
       #   assert_in_delta 0.05, (50000.0 / 10**6), 0.00001
@@ -881,8 +881,8 @@ EOT
       end
 
       ##
-      # Passes if +expected_float+ and +actual_float+ are
-      # not equal within +delta+ tolerance.
+      # Passes if `expected_float` and `actual_float` are
+      # not equal within `delta` tolerance.
       #
       # @example
       #   assert_not_in_delta(0.05, (50000.0 / 10**6), 0.00002) # -> pass
@@ -981,8 +981,8 @@ EOT
 
       public
       ##
-      # Passes if +expected_float+ and +actual_float+ are equal
-      # within +epsilon+ relative error of +expected_float+.
+      # Passes if `expected_float` and `actual_float` are equal
+      # within `epsilon` relative error of `expected_float`.
       #
       # @example
       #   assert_in_epsilon(10000.0, 9900.0, 0.1) # -> pass
@@ -1011,9 +1011,9 @@ EOT
       end
 
       ##
-      # Passes if +expected_float+ and +actual_float+ are
-      # not equal within +epsilon+ relative error of
-      # +expected_float+.
+      # Passes if `expected_float` and `actual_float` are
+      # not equal within `epsilon` relative error of
+      # `expected_float`.
       #
       # @example
       #   assert_not_in_epsilon(10000.0, 9900.0, 0.1) # -> fail
@@ -1121,7 +1121,7 @@ EOT
       ##
       # Passes if the method send returns a true value.
       #
-      # +send_array+ is composed of:
+      # `send_array` is composed of:
       # * A receiver
       # * A method
       # * Arguments to the method
@@ -1161,7 +1161,7 @@ EOT
       ##
       # Passes if the method send doesn't return a true value.
       #
-      # +send_array+ is composed of:
+      # `send_array` is composed of:
       # * A receiver
       # * A method
       # * Arguments to the method
@@ -1199,7 +1199,7 @@ EOT
       end
 
       ##
-      # Passes if +actual+ is a boolean value.
+      # Passes if `actual` is a boolean value.
       #
       # @example
       #   assert_boolean(true) # -> pass
@@ -1215,7 +1215,7 @@ EOT
       end
 
       ##
-      # Passes if +actual+ is true.
+      # Passes if `actual` is true.
       #
       # @example
       #   assert_true(true)  # -> pass
@@ -1231,7 +1231,7 @@ EOT
       end
 
       ##
-      # Passes if +actual+ is false.
+      # Passes if `actual` is false.
       #
       # @example
       #   assert_false(false)  # -> pass
@@ -1247,8 +1247,8 @@ EOT
       end
 
       ##
-      # Passes if expression "+expected+ +operator+
-      # +actual+" is true.
+      # Passes if expression "`expected` `operator`
+      # `actual`" is true.
       #
       # @example
       #   assert_compare(1, "<", 10)  # -> pass
@@ -1303,7 +1303,7 @@ EOT
 
       ##
       # Passes if an exception is raised in block and its
-      # message is +expected+.
+      # message is `expected`.
       #
       # @example
       #   assert_raise_message("exception") {raise "exception"}  # -> pass
@@ -1343,7 +1343,7 @@ EOT
       end
 
       ##
-      # Passes if +object+.const_defined?(+constant_name+)
+      # Passes if `object`.const_defined?(`constant_name`)
       #
       # @example
       #   assert_const_defined(Test, :Unit)          # -> pass
@@ -1360,7 +1360,7 @@ EOT
       end
 
       ##
-      # Passes if !+object+.const_defined?(+constant_name+)
+      # Passes if !`object`.const_defined?(`constant_name`)
       #
       # @example
       #   assert_not_const_defined(Object, :Nonexistent) # -> pass
@@ -1377,7 +1377,7 @@ EOT
       end
 
       ##
-      # Passes if +object+.+predicate+ is _true_.
+      # Passes if `object`.`predicate` is _true_.
       #
       # @example
       #   assert_predicate([], :empty?)  # -> pass
@@ -1399,7 +1399,7 @@ EOT
       end
 
       ##
-      # Passes if +object+.+predicate+ is not _true_.
+      # Passes if `object`.`predicate` is not _true_.
       #
       # @example
       #   assert_not_predicate([1], :empty?) # -> pass
@@ -1426,8 +1426,8 @@ EOT
       alias_method :refute_predicate, :assert_not_predicate
 
       ##
-      # Passes if +object+#+alias_name+ is an alias method of
-      # +object+#+original_name+.
+      # Passes if `object`#`alias_name` is an alias method of
+      # `object`#`original_name`.
       #
       # @example
       #   assert_alias_method([], :length, :size)  # -> pass
@@ -1474,7 +1474,7 @@ EOT
       end
 
       ##
-      # Passes if +path+ exists.
+      # Passes if `path` exists.
       #
       # @example
       #   assert_path_exist("/tmp")          # -> pass
@@ -1492,7 +1492,7 @@ EOT
       end
 
       ##
-      # Passes if +path+ doesn't exist.
+      # Passes if `path` doesn't exist.
       #
       # @example
       #   assert_path_not_exist("/nonexistent")  # -> pass
@@ -1510,7 +1510,7 @@ EOT
       end
 
       ##
-      # Passes if +collection+ includes +object+.
+      # Passes if `collection` includes `object`.
       #
       # @example
       #   assert_include([1, 10], 1)            # -> pass
@@ -1537,7 +1537,7 @@ EOT
       alias_method :assert_includes, :assert_include
 
       ##
-      # Passes if +collection+ doesn't include +object+.
+      # Passes if `collection` doesn't include `object`.
       #
       # @example
       #   assert_not_include([1, 10], 5)            # -> pass
@@ -1569,7 +1569,7 @@ EOT
       alias_method :refute_includes, :assert_not_include
 
       ##
-      # Passes if +object+ is empty.
+      # Passes if `object` is empty.
       #
       # @example
       #   assert_empty("")                       # -> pass
@@ -1592,7 +1592,7 @@ EOT
       end
 
       ##
-      # Passes if +object+ is not empty.
+      # Passes if `object` is not empty.
       #
       # @example
       #   assert_not_empty(" ")                      # -> pass
@@ -1620,8 +1620,8 @@ EOT
       alias_method :refute_empty, :assert_not_empty
 
       ##
-      # Builds a failure message.  +user_message+ is added before the
-      # +template+ and +arguments+ replaces the '?'s positionally in
+      # Builds a failure message.  `user_message` is added before the
+      # `template` and `arguments` replaces the '?'s positionally in
       # the template.
       def build_message(user_message, template=nil, *arguments)
         template &&= template.chomp