search

cloudfoundry / cf-drain-cli

CF CLI plugin to create syslog drains
Apache License 2.0
16 stars 7 forks source link

Inconsistent punctuation in cf-drain-cli help text #14

Closed bradylove closed 6 years ago

bradylove commented 6 years ago

When viewing the help text for the cf-drain-cli the punctuation is inconsistent. Some sentences end with periods, others do not. I would expect this to be consistent one way or the other.

Examples:

cf-drain-cli · (develop) ★  ⟩ cf plugins
Listing installed plugins...

plugin   version   command name              command help
drains   N/A       bind-drain                Binds an application to an existing syslog drain.
drains   N/A       delete-drain              Unbinds the service from applications and deletes the service.
drains   N/A       delete-drain-space        Deletes space drain app and unbinds all the apps in the space from the configured syslog drain
drains   N/A       drain                     Creates a user provided service for syslog drains and binds it to a given application.
drains   N/A       drain-service             Pushes app to drain a single service
drains   N/A       drain-services-in-space   Pushes app to drain all services in space
drains   N/A       drain-space               Pushes app to bind all apps in the space to the configured syslog drain
drains   N/A       drains                    Lists all services for syslog drains.
drains   N/A       migrate-space-drain       Migrates space drain using CUPS to space drain using syslog-forwarder application
cf-drain-cli · (develop) ★  ⟩ cf drain --help
NAME:
   drain - Creates a user provided service for syslog drains and binds it to a given application.

USAGE:
   drain APP_NAME SYSLOG_DRAIN_URL [--drain-name NAME] [--type TYPE]

OPTIONS:
   --drain-name       The name of the drain that will be created. If excluded, the drain name will be `cf-drain-UUID`.
   --type             The type of logs to be sent to the syslog drain. Available types: `logs`, `metrics`, and `all`. Default is `logs`
cf-gitbot commented 6 years ago

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/160421681

The labels on this github issue will be updated when the story is started.

bradylove commented 6 years ago

Fixed by adding punctuation to help text.