Skip to content

Commit caf5b0d

Browse files
committed
chore(*): fix tense for command summary & doc improvements
1 parent fe6b38d commit caf5b0d

12 files changed

Lines changed: 22 additions & 13 deletions

File tree

src/commands/build.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Build < Base
33
def setup : Nil
44
@name = "build"
5-
@summary = "builds one or more targets from shard.yml"
5+
@summary = "build one or more targets from shard.yml"
66
@description = <<-DESC
77
Builds one or more specified targets from a shard.yml file. If no targets are
88
specified, all defined targets will be built concurrently. The output of the

src/commands/config.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Config < Base
33
def setup : Nil
44
@name = "config"
5-
@summary = "manages the geode config"
5+
@summary = "manage the geode config"
66

77
add_usage "config set <key> <value>"
88
add_usage "config setup"

src/commands/info.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Info < Base
33
def setup : Nil
44
@name = "info"
5-
@summary = "gets information about a shard"
5+
@summary = "get information about a shard"
66
@description = "Gets information about a specified shard."
77

88
add_usage "info <shard>"

src/commands/init.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ module Geode::Commands
55

66
def setup : Nil
77
@name = "init"
8-
@summary = "initializes a shard.yml file"
8+
@summary = "initialize a shard.yml file"
99
@description = <<-DESC
1010
Initializes a shard.yml file in the current directory. By default this command is
1111
interactive, but you can skip it by including the '--skip' flag. The command will

src/commands/install.cr

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Install < Base
33
def setup : Nil
44
@name = "install"
5-
@summary = "installs dependencies from shard.yml"
5+
@summary = "install dependencies from shard.yml"
66
@description = <<-DESC
77
Installs dependencies from a shard.yml file. This includes development dependencies
88
unless you include the '--production' flag.
@@ -18,6 +18,7 @@ module Geode::Commands
1818
add_option "local"
1919
add_option "production"
2020
add_option 'P', "skip-postinstall"
21+
# add_option 'S', "shard"
2122
end
2223

2324
def pre_run(arguments : Cling::Arguments, options : Cling::Options) : Nil

src/commands/licenses.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ module Geode::Commands
44
class Licenses < Base
55
def setup : Nil
66
@name = "licenses"
7-
@summary = "gets shard licenses information"
7+
@summary = "get shard license information"
88
@description = <<-DESC
99
Gets licening information from installed shards. This will also list general
1010
conditions permitted by the licenses.

src/commands/list.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module Geode::Commands
2222

2323
def setup : Nil
2424
@name = "list"
25-
@summary = "lists installed shards"
25+
@summary = "list installed shards"
2626
@description = <<-DESC
2727
Lists the shards that have been installed. Due to the nature of the Shards CLI,
2828
transitive dependencies will also be listed even if they are not directly

src/commands/remove.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Remove < Base
33
def setup : Nil
44
@name = "remove"
5-
@summary = "removes one or more dependencies from shard.yml"
5+
@summary = "remove one or more dependencies from shard.yml"
66

77
add_usage "remove <shards...>"
88
add_argument "shards", description: "the names of the shards", multiple: true, required: true

src/commands/run.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Run < Base
33
def setup : Nil
44
@name = "run"
5-
@summary = "runs a script from shard.yml"
5+
@summary = "run a script from shard.yml"
66
@description = <<-DESC
77
Runs a specified script from a local shard.yml file. You can also run a script
88
from an installed shard by specifying the '--shard' flag. If target platforms

src/commands/version.cr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module Geode::Commands
22
class Version < Base
33
def setup : Nil
44
@name = "version"
5-
@summary = "gets the version information about Geode"
5+
@summary = "get version information about Geode"
66
@description = "Gets the version information about Geode."
77
end
88

0 commit comments

Comments
 (0)