Commit 1626b8a1 authored by Samuel E. Giddins's avatar Samuel E. Giddins

Merge pull request #4798 from nwest/command-help-consistency

Audit CLI help for period consistency
parents 289ca870 eb451c42
...@@ -4,7 +4,7 @@ require 'active_support/core_ext/string/strip' ...@@ -4,7 +4,7 @@ require 'active_support/core_ext/string/strip'
module Pod module Pod
class Command class Command
class Init < Command class Init < Command
self.summary = 'Generate a Podfile for the current directory.' self.summary = 'Generate a Podfile for the current directory'
self.description = <<-DESC self.description = <<-DESC
Creates a Podfile for the current directory if none currently exists. If Creates a Podfile for the current directory if none currently exists. If
an `XCODEPROJ` project file is specified or if there is only a single an `XCODEPROJ` project file is specified or if there is only a single
......
...@@ -11,7 +11,7 @@ module Pod ...@@ -11,7 +11,7 @@ module Pod
#-----------------------------------------------------------------------# #-----------------------------------------------------------------------#
class Spec < IPC class Spec < IPC
self.summary = 'Converts a podspec to JSON.' self.summary = 'Converts a podspec to JSON'
self.description = 'Converts a podspec to JSON and prints it to STDOUT.' self.description = 'Converts a podspec to JSON and prints it to STDOUT.'
self.arguments = [ self.arguments = [
CLAide::Argument.new('PATH', true), CLAide::Argument.new('PATH', true),
...@@ -37,7 +37,7 @@ module Pod ...@@ -37,7 +37,7 @@ module Pod
#-----------------------------------------------------------------------# #-----------------------------------------------------------------------#
class Podfile < IPC class Podfile < IPC
self.summary = 'Converts a Podfile to YAML.' self.summary = 'Converts a Podfile to YAML'
self.description = 'Converts a Podfile to YAML and prints it to STDOUT.' self.description = 'Converts a Podfile to YAML and prints it to STDOUT.'
self.arguments = [ self.arguments = [
CLAide::Argument.new('PATH', true), CLAide::Argument.new('PATH', true),
...@@ -63,7 +63,7 @@ module Pod ...@@ -63,7 +63,7 @@ module Pod
#-----------------------------------------------------------------------# #-----------------------------------------------------------------------#
class List < IPC class List < IPC
self.summary = 'Lists the specifications known to CocoaPods.' self.summary = 'Lists the specifications known to CocoaPods'
self.description = <<-DESC self.description = <<-DESC
Prints to STDOUT a YAML dictionary where the keys are the name of the Prints to STDOUT a YAML dictionary where the keys are the name of the
specifications and each corresponding value is a dictionary with specifications and each corresponding value is a dictionary with
...@@ -101,7 +101,7 @@ module Pod ...@@ -101,7 +101,7 @@ module Pod
#-----------------------------------------------------------------------# #-----------------------------------------------------------------------#
class UpdateSearchIndex < IPC class UpdateSearchIndex < IPC
self.summary = 'Updates the search index.' self.summary = 'Updates the search index'
self.description = <<-DESC self.description = <<-DESC
Updates the search index and prints its path to standard output. Updates the search index and prints its path to standard output.
The search index is a YAML encoded dictionary where the keys The search index is a YAML encoded dictionary where the keys
...@@ -125,7 +125,7 @@ module Pod ...@@ -125,7 +125,7 @@ module Pod
class Repl < IPC class Repl < IPC
END_OF_OUTPUT_SIGNAL = "\n\r" END_OF_OUTPUT_SIGNAL = "\n\r"
self.summary = 'The repl listens to commands on standard input.' self.summary = 'The repl listens to commands on standard input'
self.description = <<-DESC self.description = <<-DESC
The repl listens to commands on standard input and prints their The repl listens to commands on standard input and prints their
result to standard output. result to standard output.
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Repo < Command class Repo < Command
class Add < Repo class Add < Repo
self.summary = 'Add a spec repo.' self.summary = 'Add a spec repo'
self.description = <<-DESC self.description = <<-DESC
Clones `URL` in the local spec-repos directory at `~/.cocoapods/repos/`. The Clones `URL` in the local spec-repos directory at `~/.cocoapods/repos/`. The
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Repo < Command class Repo < Command
class Lint < Repo class Lint < Repo
self.summary = 'Validates all specs in a repo.' self.summary = 'Validates all specs in a repo'
self.description = <<-DESC self.description = <<-DESC
Lints the spec-repo `NAME`. If a directory is provided it is assumed Lints the spec-repo `NAME`. If a directory is provided it is assumed
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Repo < Command class Repo < Command
class Update < Repo class Update < Repo
self.summary = 'Update a spec repo.' self.summary = 'Update a spec repo'
self.description = <<-DESC self.description = <<-DESC
Updates the local clone of the spec-repo `NAME`. If `NAME` is omitted Updates the local clone of the spec-repo `NAME`. If `NAME` is omitted
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Spec < Command class Spec < Command
class Cat < Spec class Cat < Spec
self.summary = 'Prints a spec file.' self.summary = 'Prints a spec file'
self.description = <<-DESC self.description = <<-DESC
Prints the content of the podspec(s) whose name matches `QUERY` to standard output. Prints the content of the podspec(s) whose name matches `QUERY` to standard output.
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Spec < Command class Spec < Command
class Edit < Spec class Edit < Spec
self.summary = 'Edit a spec file.' self.summary = 'Edit a spec file'
self.description = <<-DESC self.description = <<-DESC
Opens the podspec matching `QUERY` to be edited. Opens the podspec matching `QUERY` to be edited.
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Spec < Command class Spec < Command
class Lint < Spec class Lint < Spec
self.summary = 'Validates a spec file.' self.summary = 'Validates a spec file'
self.description = <<-DESC self.description = <<-DESC
Validates `NAME.podspec`. If a `DIRECTORY` is provided, it validates Validates `NAME.podspec`. If a `DIRECTORY` is provided, it validates
......
...@@ -2,7 +2,7 @@ module Pod ...@@ -2,7 +2,7 @@ module Pod
class Command class Command
class Spec < Command class Spec < Command
class Which < Spec class Which < Spec
self.summary = 'Prints the path of the given spec.' self.summary = 'Prints the path of the given spec'
self.description = <<-DESC self.description = <<-DESC
Prints the path of the .podspec file(s) whose name matches `QUERY` Prints the path of the .podspec file(s) whose name matches `QUERY`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment