From d6cd3b951e76a19736b746ead3d708d144aa0acc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Prod=27homme?= Date: Sun, 12 Nov 2023 15:44:27 +0100 Subject: [PATCH] Improve the code documentation with indentation that make the balise inside the generated documentation --- lib/thor/shell/basic.rb | 14 +++++++------- lib/thor/shell/html.rb | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/lib/thor/shell/basic.rb b/lib/thor/shell/basic.rb index e20f132c..394e8fae 100644 --- a/lib/thor/shell/basic.rb +++ b/lib/thor/shell/basic.rb @@ -67,15 +67,15 @@ def indent(count = 1) # Readline. # # ==== Example - # ask("What is your name?") + # ask("What is your name?") # - # ask("What is the planet furthest from the sun?", :default => "Pluto") + # ask("What is the planet furthest from the sun?", :default => "Neptune") # - # ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"]) + # ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"]) # - # ask("What is your password?", :echo => false) + # ask("What is your password?", :echo => false) # - # ask("Where should the file be saved?", :path => true) + # ask("Where should the file be saved?", :path => true) # def ask(statement, *args) options = args.last.is_a?(Hash) ? args.pop : {} @@ -93,7 +93,7 @@ def ask(statement, *args) # are passed straight to puts (behavior got from Highline). # # ==== Example - # say("I know you knew that.") + # say("I know you knew that.") # def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/)) return if quiet? @@ -110,7 +110,7 @@ def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/) # are passed straight to puts (behavior got from Highline). # # ==== Example - # say_error("error: something went wrong") + # say_error("error: something went wrong") # def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/)) return if quiet? diff --git a/lib/thor/shell/html.rb b/lib/thor/shell/html.rb index 547a9da5..bb3ef666 100644 --- a/lib/thor/shell/html.rb +++ b/lib/thor/shell/html.rb @@ -67,7 +67,7 @@ def set_color(string, *colors) # Ask something to the user and receives a response. # # ==== Example - # ask("What is your name?") + # ask("What is your name?") # # TODO: Implement #ask for Thor::Shell::HTML def ask(statement, color = nil)