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

MAINT: Updated helptext to display the correct command #216

Merged
merged 3 commits into from Jun 7, 2019
Merged

MAINT: Updated helptext to display the correct command #216

merged 3 commits into from Jun 7, 2019

Conversation

David-Rod
Copy link
Contributor

@David-Rod David-Rod commented Jun 5, 2019

This pull request is responsible for prompting the users to use the appropriate command. The previous command was not correct and prompted users to use a nonexistent command closes #215

@ChrisKeefe ChrisKeefe self-assigned this Jun 5, 2019
@ChrisKeefe ChrisKeefe self-requested a review June 5, 2019 22:01
@@ -274,7 +274,7 @@ def _load_metadata(path):
@tools.command(short_help='View a QIIME 2 Visualization.',
help="Displays a QIIME 2 Visualization until the command "
"exits. To open a QIIME 2 Visualization so it can be "
"used after the command exits, use 'qiime extract'.",
"used after the command exits, use 'qiime tools view --help'.",
Copy link
Contributor

Choose a reason for hiding this comment

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

New helptext needs a lil tweak. Take a quick look at the expected behavior section of the original issue. 😉

Copy link
Contributor

@ChrisKeefe ChrisKeefe left a comment

Choose a reason for hiding this comment

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

Thanks for pulling this PR together, @Davrod29!
One quick change (requested inline), and we should be ready to roll. 👍

Let's talk linting and continuous integration before you push your next changes? Both good toolboxes we can put to use here.

Commit that should include liting within dev environment
@thermokarst thermokarst added this to In Review in 2019.7 via automation Jun 7, 2019
Copy link
Contributor

@thermokarst thermokarst left a comment

Choose a reason for hiding this comment

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

Lookin' good @Davrod29! I have a few incredibly minor comments, inline. Thanks!

@@ -16,7 +16,6 @@

_COMBO_METAVAR = 'ARTIFACT/VISUALIZATION'


Copy link
Contributor

Choose a reason for hiding this comment

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

I like to try and keep my diffs as minimal as possible - I think it helps future readers of the code (especially when they are using a tool like git). A "no-op" change like this can create noise (in my opinion). Can you undo the deletion of this line?

@@ -404,7 +403,7 @@ def validate(path, level):
result.validate(level)
except qiime2.plugin.ValidationError as e:
header = 'Result %s does not appear to be valid at level=%s:' % (
path, level)
path, level)
Copy link
Contributor

Choose a reason for hiding this comment

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

Was this change necessary for the overall goal of the PR? If not, maybe we can undo the change (for the reasons given above). Sorry, don't mean to be pedantic, thanks for bearing with me!

@thermokarst thermokarst assigned David-Rod and unassigned ChrisKeefe Jun 7, 2019
@thermokarst thermokarst moved this from In Review to In Development in 2019.7 Jun 7, 2019
@David-Rod
Copy link
Contributor Author

David-Rod commented Jun 7, 2019 via email

@thermokarst
Copy link
Contributor

No worries @Davrod29, and certainly no need to apologize at all! There are a lot of new things coming your way right now, I feel bad about tossing one more thing ™️ at you, but, I know you've got this!

🍾

Copy link
Member

@ebolyen ebolyen left a comment

Choose a reason for hiding this comment

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

Thanks @Davrod29, @ChrisKeefe will practice merging this (if it works).

@ChrisKeefe ChrisKeefe merged commit 5792e31 into qiime2:master Jun 7, 2019
2019.7 automation moved this from In Development to Changelog Needed Jun 7, 2019
@thermokarst thermokarst moved this from Changelog Needed to Completed in 2019.7 Jul 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
2019.7
  
Completed
Development

Successfully merging this pull request may close these issues.

BUG: qiime extract suggested by qiime tools view --help is not a command
4 participants