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

Use standard Galaxy message box styles on tool help texts that use rST admonitions #685

Merged
merged 1 commit into from Sep 2, 2015

Conversation

@natefoo
Copy link
Member

natefoo commented Sep 1, 2015

rST admonitions allow you to create a block that is intended to stand out. Three of these admonition types, warning, error, and note align nicely with Galaxy's warningmessage, errormessage, and infomessage classes.

This change makes it possible to use those admonition types in tool help text and have them render as the corresponding Galaxy message types.

@natefoo

This comment has been minimized.

Copy link
Member Author

natefoo commented Sep 1, 2015

FWIW I want this on Main for a tool we'll be adding that needs a big 'ole "beta" disclaimer but it's not a bug fix so it breaks the rules to accept it into 15.07. Perhaps now is the time to create a "usegalaxy.org" branch.

@martenson

This comment has been minimized.

Copy link
Member

martenson commented Sep 2, 2015

I like this. I also wouldn't bother with usegalaxy branch, it will add overhead I do not deem justified. Let's just PR against 15.07

That said you know better than me if the overhead is worth it.

martenson added a commit that referenced this pull request Sep 2, 2015
Use standard Galaxy message box styles on tool help texts that use rST admonitions
@martenson martenson merged commit 291d16f into galaxyproject:dev Sep 2, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@natefoo

This comment has been minimized.

Copy link
Member Author

natefoo commented Sep 3, 2015

@martenson The problem is that it violates the rules for admission into 15.07, because it's not a bug fix. It's about as harmless a new feature as they come, but it's still against the rules.

@martenson

This comment has been minimized.

Copy link
Member

martenson commented Sep 3, 2015

I understand, I just do not like that rule. I am fine with having it in 15.07.

@nsoranzo

This comment has been minimized.

Copy link
Member

nsoranzo commented Sep 3, 2015

@natefoo Cherry-picking the commit on Main could also be an option for you, should not be a problem when upgrading to the next release.

@natefoo

This comment has been minimized.

Copy link
Member Author

natefoo commented Sep 3, 2015

@nsoranzo Great point, I hadn't considered that.

@natefoo natefoo deleted the natefoo:help-message-css branch Oct 29, 2015
@bgruening

This comment has been minimized.

Copy link
Member

bgruening commented Feb 8, 2016

@natefoo should this work:

.. error:: This is a note admonition.
   This is the second line of the first paragraph.

   - The note contains all indented body elements
     following.
   - It includes this bullet list.

It doesn't for me on 16.01.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.