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

Add tool parameter argument to parameter help #346

Merged
merged 2 commits into from
Jun 15, 2015

Conversation

guerler
Copy link
Contributor

@guerler guerler commented Jun 15, 2015

This PR automatically adds the tool parameter argument name to the parameters help text.
See: #8

@hexylena
Copy link
Member

cc @bgruening

@bgruening
Copy link
Member

Great @guerler - Thanks for implementing! 👍

@@ -124,6 +124,9 @@ define([], function() {
tmp += '<div class="ui-table-form-info">';
if (options.help) {
tmp += options.help;
if (options.argument) {
Copy link
Member

Choose a reason for hiding this comment

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

Maybe here we should check that options.help does not already contain options.argument to make it possible for tool developers to cleanly support old and new Galaxy syntax.

Copy link
Member

Choose a reason for hiding this comment

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

yep, there are a ton of IUC tools which encode the argument like this.

@nsoranzo
Copy link
Member

👍

1 similar comment
@jmchilton
Copy link
Member

👍

guerler added a commit that referenced this pull request Jun 15, 2015
Add tool parameter argument to parameter help
@guerler guerler merged commit 3983de3 into galaxyproject:dev Jun 15, 2015
@guerler guerler deleted the add_argument_000 branch November 1, 2015 16:54
@yhoogstrate
Copy link
Member

@erasche @guerler @nsoranzo
<param name="max" label="Take the max" argument="--max" /> will show no help section and thus won't show the (--max) argument.
Is it on purpose that if help= is not being set, it won't be created by setting argument=, or is this a small bug?

@nsoranzo
Copy link
Member

nsoranzo commented Feb 2, 2016

I'd say small bug.

@bgruening
Copy link
Member

I guess this is a bug. If you include an empty help it will be shown.
On Feb 2, 2016 1:34 PM, yhoogstrate notifications@github.com wrote:@erasche @guerler @nsoranzo

will show no help section and thus won't show the (--max) argument. Is it on purpose that if help= is not being set, it won't be created by setting argument=, or is this a small bug?

—Reply to this email directly or view it on GitHub.

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

Successfully merging this pull request may close these issues.

None yet

6 participants