string.rb in ronin-support-0.5.0

- old
+ new

@@ -90,11 +90,11 @@
   end
 
   #
   # Repeats the String.
   #
-  # @param [Enumerable, Integer] lengths
+  # @param [Enumerable<Integer>, Integer] lengths
   #   The number of times to repeat the String.
   #
   # @yield [repeated]
   #   The given block will be passed every repeated String.
   #
@@ -139,11 +139,11 @@
   end
 
   #
   # Incrementally fuzzes the String.
   #
-  # @param [Hash{Regexp,String => #each}] substitutions
+  # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] substitutions
   #   Patterns and their substitutions.
   #
   # @yield [fuzz]
   #   The given block will be passed every fuzzed String.
   #
@@ -161,10 +161,13 @@
   # @example {String.generate} with {String#fuzz}:
   #   "GET /".fuzz('/' => String.generate(['A', 1..100])) do |str|
   #     p str
   #   end
   #
+  # @example Replace a {Regexp::UNIX_PATH} with {Ronin::Fuzzing#format_strings}:
+  #   "GET /downloads/".fuzz(:unix_path => :format_string)
+  #
   # @since 0.3.0
   #
   # @api public
   #
   def fuzz(substitutions={},&block)
@@ -172,10 +175,10 @@
   end
 
   #
   # Permutes over every possible mutation of the String.
   #
-  # @param [Hash{Regexp,String,Symbol => Symbol,Enumerable}] mutations
+  # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] mutations
   #   The patterns and substitutions to mutate the String with.
   #
   # @yield [mutant]
   #   The given block will be yielded every possible mutant String.
   #