Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

autodoc on releases #209

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

autodoc on releases #209

wants to merge 2 commits into from

Conversation

jdx
Copy link
Contributor

@jdx jdx commented May 30, 2018

No description provided.

@codecov-io
Copy link

codecov-io commented May 30, 2018

Codecov Report

Merging #209 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #209   +/-   ##
=======================================
  Coverage   95.29%   95.29%           
=======================================
  Files          55       55           
  Lines        1381     1381           
=======================================
  Hits         1316     1316           
  Misses         65       65
Impacted Files Coverage Δ
commands/maintenance/window.js 100% <ø> (ø) ⬆️
commands/credentials/destroy.js 95.45% <ø> (ø) ⬆️
commands/credentials/create.js 100% <ø> (ø) ⬆️
commands/links/create.js 100% <ø> (ø) ⬆️
commands/pull.js 94.62% <ø> (ø) ⬆️
commands/connection_pooling.js 100% <ø> (ø) ⬆️
commands/credentials/repair_default.js 100% <ø> (ø) ⬆️
commands/links/destroy.js 100% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c4c366a...3d27659. Read the comment docs.


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',
Copy link
Contributor

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?

Copy link
Contributor Author

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

Copy link
Contributor Author

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

Copy link
Contributor

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants