Skip to content

Commit 91b6fa0

Browse files
committed
Remove stdio from generated tools - just use exit_code for everything.
Other small formatting tweaks - but less than #674 since I'm trying to keep these tools the way they are when tool_init generates them - at least for those options. This also doesn't strip stdio from other places like the bwa test tool that broke the tests in #674.
1 parent 6a3f18a commit 91b6fa0

14 files changed

+32
-65
lines changed

docs/_writing_intro.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ definitions for the input and output as well as an actual command template.
5353

5454
.. literalinclude:: writing/seqtk_seq_v2.xml
5555
:language: xml
56-
:emphasize-lines: 8-16
56+
:emphasize-lines: 5-13
5757

5858
.. include:: _writing_from_help_command.rst
5959

@@ -76,7 +76,7 @@ underlying tool. The resulting tool XML file is:
7676

7777
.. literalinclude:: writing/seqtk_seq_v3.xml
7878
:language: xml
79-
:emphasize-lines: 17-58
79+
:emphasize-lines: 14-55
8080

8181
.. include:: _writing_lint_intro.rst
8282

docs/_writing_parameters.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ At this point the tool would look like:
5050

5151
.. literalinclude:: writing/seqtk_seq_v4.xml
5252
:language: xml
53-
:emphasize-lines: 10-13,17-23
53+
:emphasize-lines: 7-10,14-20
5454

5555

5656
Conditional Parameters
@@ -121,7 +121,7 @@ The newest version of this tool is now
121121

122122
.. literalinclude:: writing/seqtk_seq_v5.xml
123123
:language: xml
124-
:emphasize-lines: 13-19,31-43
124+
:emphasize-lines: 10-16,28-40
125125

126126
For tools like this where there are many options but in the most uses the defaults
127127
are preferred - a common idiom is to break the parameters into simple and
@@ -131,4 +131,4 @@ Updating this tool to use that idiom might look as follows.
131131

132132
.. literalinclude:: writing/seqtk_seq_v6.xml
133133
:language: xml
134-
:emphasize-lines: 10-21,26-33,54-55
134+
:emphasize-lines: 7-18,23-30,51-52

docs/_writing_suites.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This will produce the two files in your current directory instead of just one
3030

3131
.. literalinclude:: writing/seqtk_seq_with_macros.xml
3232
:language: xml
33-
:emphasize-lines: 2-6,46
33+
:emphasize-lines: 2-5,45
3434

3535
.. literalinclude:: writing/seqtk_macros.xml
3636
:language: xml

docs/writing/gen.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ mv seqtk_seq.xml seqtk_seq_v1.xml
55
planemo tool_init --force \
66
--id 'seqtk_seq' \
77
--name 'Convert to FASTA (seqtk)' \
8-
--requirement seqtk@1.0-r68 \
8+
--requirement seqtk@1.2 \
99
--example_command 'seqtk seq -a 2.fastq > 2.fasta' \
1010
--example_input 2.fastq \
1111
--example_output 2.fasta
1212
mv seqtk_seq.xml seqtk_seq_v2.xml
1313
planemo tool_init --force \
1414
--id 'seqtk_seq' \
1515
--name 'Convert to FASTA (seqtk)' \
16-
--requirement seqtk@1.0-r68 \
16+
--requirement seqtk@1.2 \
1717
--example_command 'seqtk seq -a 2.fastq > 2.fasta' \
1818
--example_input 2.fastq \
1919
--example_output 2.fasta \

docs/writing/seqtk_macros.xml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,9 @@
55
<yield/>
66
</requirements>
77
</xml>
8-
<xml name="stdio">
9-
<stdio>
10-
<exit_code range="1:" />
11-
</stdio>
12-
</xml>
138
<xml name="citations">
149
<citations>
1510
<yield />
1611
</citations>
1712
</xml>
18-
</macros>
13+
</macros>

docs/writing/seqtk_seq_v1.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
<tool id="seqtk_seq" name="Convert to FASTA (seqtk)" version="0.1.0">
22
<requirements>
33
</requirements>
4-
<stdio>
5-
<exit_code range="1:" />
6-
</stdio>
7-
<command><![CDATA[
4+
<command detect_errors="exit_code"><![CDATA[
85
TODO: Fill in command template.
96
]]></command>
107
<inputs>

docs/writing/seqtk_seq_v2.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
<requirements>
33
<requirement type="package" version="1.2">seqtk</requirement>
44
</requirements>
5-
<stdio>
6-
<exit_code range="1:" />
7-
</stdio>
8-
<command><![CDATA[
5+
<command detect_errors="exit_code"><![CDATA[
96
seqtk seq -a "$input1" > "$output1"
107
]]></command>
118
<inputs>

docs/writing/seqtk_seq_v3.cwl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ cwlVersion: 'cwl:draft-3'
33
class: CommandLineTool
44
id: "seqtk_seq"
55
label: "Convert to FASTA (seqtk)"
6-
requirements:
6+
hints:
77
- class: DockerRequirement
88
dockerPull: dukegcb/seqtk
99
inputs:

docs/writing/seqtk_seq_v3.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
<requirements>
33
<requirement type="package" version="1.2">seqtk</requirement>
44
</requirements>
5-
<stdio>
6-
<exit_code range="1:" />
7-
</stdio>
8-
<command><![CDATA[
5+
<command detect_errors="exit_code"><![CDATA[
96
seqtk seq -a "$input1" > "$output1"
107
]]></command>
118
<inputs>

docs/writing/seqtk_seq_v4.xml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
<requirements>
33
<requirement type="package" version="1.2">seqtk</requirement>
44
</requirements>
5-
<stdio>
6-
<exit_code range="1:" />
7-
</stdio>
8-
<command><![CDATA[
5+
<command detect_errors="exit_code"><![CDATA[
96
seqtk seq
107
$shift_quality
118
-q $quality_min

0 commit comments

Comments
 (0)