Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve examples and help in several commands #2277

Merged
merged 2 commits into from May 27, 2020

Conversation

rfay
Copy link
Member

@rfay rfay commented May 24, 2020

The Problem/Issue/Bug:

Some older commands had no examples at all. Some help text was a bit out of date.

How this PR Solves The Problem:

Add examples to most commands.

Manual Testing Instructions:

Automated Testing Overview:

Related Issue Link(s):

Release/Deployment notes:

Copy link

@AlexCreamer AlexCreamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This look like very nice addition. It seems to give more of an incentive to run some of the commands to see what the examples are. And with the examples being better. The import-files one stumped me, but with the --src example it might help some people. **** Perhaps adding that in some text that import-files supports .sql would be good. Preferably through whatever users will easily see. Not sure if using "long" text would make people easily see it since they may not see that from the command line.

@rfay
Copy link
Member Author

rfay commented May 27, 2020

Thanks for taking a look @AlexCreamer ! The "short" text is shown when you just type "ddev", the long text when you type ddev help <command> or ddev command -h

@rfay rfay merged commit ddfd8d3 into ddev:master May 27, 2020
@rfay rfay deleted the 20200523_improve_examples branch May 27, 2020 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants