diff options
author | Abinoam P. Marques Jr <abinoam@gmail.com> | 2017-09-24 22:51:52 -0300 |
---|---|---|
committer | Abinoam P. Marques Jr <abinoam@gmail.com> | 2017-09-25 06:51:00 -0300 |
commit | e4aef4f20a2cab1f471eca70bb5fa52ffadebfe7 (patch) | |
tree | 27335a7ad81cc469d3391f3588f60fe3e71d6989 | |
parent | fc31611ef5083bb4a3ece4511ac40c02f76b527d (diff) | |
download | highline-e4aef4f20a2cab1f471eca70bb5fa52ffadebfe7.tar.gz |
Adjust documentation
-rw-r--r-- | examples/basic_usage.rb | 3 | ||||
-rwxr-xr-x | lib/highline.rb | 2 | ||||
-rw-r--r-- | lib/highline/string_extensions.rb | 2 | ||||
-rwxr-xr-x | lib/highline/style.rb | 2 |
4 files changed, 6 insertions, 3 deletions
diff --git a/examples/basic_usage.rb b/examples/basic_usage.rb index aa1cf90..c97b89f 100644 --- a/examples/basic_usage.rb +++ b/examples/basic_usage.rb @@ -15,6 +15,9 @@ puts contacts = [] +# Just define a parse class method and use the class +# as a parser for HighLine#ask +# class NameClass def self.parse(string) raise ArgumentError, "Invalid name format." unless diff --git a/lib/highline.rb b/lib/highline.rb index 7ab4d29..360a5c9 100755 --- a/lib/highline.rb +++ b/lib/highline.rb @@ -40,7 +40,7 @@ require "highline/builtin_styles" # cli = HighLine.new # answer = cli.ask "What do you think?" # puts "You have answered: #{answer}" - +# class HighLine include BuiltinStyles include CustomErrors diff --git a/lib/highline/string_extensions.rb b/lib/highline/string_extensions.rb index bdeaf5a..521c4e4 100644 --- a/lib/highline/string_extensions.rb +++ b/lib/highline/string_extensions.rb @@ -1,6 +1,6 @@ # coding: utf-8 -class HighLine +class HighLine #:nodoc: # Returns a HighLine::String from any given String. # @param s [String] # @return [HighLine::String] from the given string. diff --git a/lib/highline/style.rb b/lib/highline/style.rb index 3484800..0ac5102 100755 --- a/lib/highline/style.rb +++ b/lib/highline/style.rb @@ -8,7 +8,7 @@ # # This is Free Software. See LICENSE and COPYING for details -class HighLine +class HighLine #:nodoc: # Creates a style using {.find_or_create_style} or # {.find_or_create_style_list} # @param args [Array<Style, Hash, String>] style properties |