heroku / legacy-cli

Heroku CLI
https://cli.heroku.com
MIT License
1.36k stars 381 forks source link

Fix missing `heroku help` descriptions for `pg` and `pg:copy` commands #2040

Open kevinzwhuang opened 7 years ago

kevinzwhuang commented 7 years ago

Summary:

Currently in the heroku CLI, the root heroku help outputs a list of commands with their descriptions, with the pg command missing a description. Screenshot: screenshot from 2016-11-28 14-52-28

The same is also true for heroku help pg, where the pg:copy command is missing a description as well. Screenshot: screenshot from 2016-11-28 14-52-56

Changes Proposed:

The pg command is missing its description possibly due to the fact that the class is split between pg_backups.rb and pg.rb - where the description is present in pg.rb and absent in pg_backups.rb. Copying the description over to pg_backups.rb fixes the missing pg description.

The description for the pg:copy command was formatted differently than the rest of the other regular subcommand descriptions, with the description written beneath the flag descriptions. Moving the main description immediately below the CLI definition fixed this problem.

Screenshots of heroku help CLI once this fix is built: screenshot from 2016-11-28 14-54-41

screenshot from 2016-11-28 14-54-59


cc: @dickeyxxx @ransombriggs