Skip to content

Commit 08de8de

Browse files
committed
Docfix: Update normalize help text to be scary.
Reflect the fact that I don't think the output should actually be meant to be a human readable tool (nothing but problems - see #125, #110, galaxyproject/tools-devteam#75).
1 parent e3d735c commit 08de8de

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

planemo/commands/cmd_normalize.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,16 @@
3636
)
3737
@pass_context
3838
def cli(ctx, path, expand_macros=False, **kwds):
39-
"""Generate normalized tool XML from input.
39+
"""Generate normalized tool XML from input (breaks formatting).
40+
41+
This will break the formatting of your tool and is currently only intended
42+
for viewing macro expansions for for use with XSD validation (see
43+
https://github.com/JeanFred/Galaxy-XSD for instance). Please do not use
44+
the output as is - it frequently makes tool less readable not more.
4045
4146
The top-level blocks will be reordered and whitespace fixed according to
4247
the tool development best practices outlined on the Galaxy wiki.
4348
44-
See also https://wiki.galaxyproject.org/Tools/BestPractices.
45-
4649
::
4750
4851
% # Print normalized version of tool.

0 commit comments

Comments
 (0)