-
Notifications
You must be signed in to change notification settings - Fork 17
autodoc on releases #209
base: master
Are you sure you want to change the base?
autodoc on releases #209
Conversation
Codecov Report
@@ Coverage Diff @@
## master #209 +/- ##
=======================================
Coverage 95.29% 95.29%
=======================================
Files 55 55
Lines 1381 1381
=======================================
Hits 1316 1316
Misses 65 65
Continue to review full report at Codecov.
|
|
||
heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production | ||
`, | ||
examples: '$ heroku pg:credentials:destroy postgresql-transparent-56874 --name cred-name -a woodstock-production', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jdxcode i noticed that some of our examples include -a ...
, and some assume it's implicit. Is there a convention for CLI examples re: this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there isn't and we should settle on a standard. My initial thought is to leave it out as the app name is already specified in the help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel -a
is so common in the CLI the users learn it pretty quickly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, makes sense to me. You can leave as is for now; I'll try to drop -a
in the future.
No description provided.