Open peterjc opened 7 years ago
@peterjc go ahead and make a PR :)
:100:
Note that right now the tools-iuc
XML files have a range of usage here - and its the kind of change while it is trivial in theory, it would be easy to accidentally break things.
Indentation is not significant in Cheetah, so this kind of changes shouldn't have any impact.
Any way I'm happy to have this as a suggested (not mandatory) code style.
👍
Cross reference https://github.com/galaxyproject/tools-iuc/pull/1346#discussion_r120591676 from @nsoranzo
Should we have a recommend style for indenting CDATA blocks? I agree with him that excessive indentation of the command tags is undesirable, and likewise for the RST in the help tags having no extra indentation makes copy/paste to and from an RST editor far easier.
My proposal:
Multiple lines of content should be written as follows (example based on
tools/trinotate/trinotate.xml
), aligned starting flush left rather than following the XML containing tag's indentation:Do not use a new line for the opening
<![CDATA[
text nor the closing]]>
text.Do not leave a blank line after the opening tag and
<![CDATA[
, nor leave a blank line before the closing]]>
and closing tag.Single lines of content may be written as either:
(example from
tools/xpath/xpath.xml
), or following the recommenced multi-line style: