galaxyproject / galaxyproject/galaxy
Tool form, RST, and Help
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 1.2k
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 169
Description
It would be nice if we could stick some occasional RST/more structured text in the `help=""` attribute of tool parameters.
A highly related request would be to link to particular sections of the help text. My use case is documentation like [this](http://bioinfo.ut.ee/primer3/primer3web_help.htm#SEQUENCE_START_CODON_POSITION) which I'd like to hyperlink back and forth for the user between the tool form and the help block.
Contributor guide
Research direction
Start by tracing how the tool form reads and renders the help attribute for tool parameters. Investigate how structured RST-like text and anchors could be preserved, then verify that users can navigate between the tool form and named sections in the help block. Done means both formatted help and links to specific sections work.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100