Skip to content

Commit

Permalink
Rewrite best practices to encourage tabs
Browse files Browse the repository at this point in the history
While still allowing spaces, and just promoting consistency.
Fixes #73
  • Loading branch information
hexylena committed Nov 14, 2022
1 parent a26656b commit 9c17c4c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/best_practices/integration_checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Creating the Tool Wrapper (XML File)
- Provide the comment-only ``tool_data_table_conf.xml.sample`` file
- Check that the XML elements and parameters attributes are in the `Order specified in the Best Practices <http://galaxy-iuc-standards.readthedocs.io/en/latest/best_practices/tool_xml.html#coding-style>`__.
- If you have a collection of related tools you can try to avoid duplicating XML by using a `Macros XML file <http://planemo.readthedocs.io/en/latest/writing_standalone.html#macros>`__
- Use 4 spaces for indentation.
- Use tabs for indentation. (4 space indentation is permitted as long as the author is consistent)

This comment has been minimized.

Copy link
@peterjc

peterjc Nov 14, 2022

Contributor

Minor, but move the full stop to the end?:

Use tabs for indentation (4 space indentation is permitted as long as the author is consistent).

Testing Your Tool
-----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/best_practices/tool_xml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ TODO
Coding Style
------------

* 4 spaces indent
* Tabs for indentation (spaces permitted if consistent.)

This comment has been minimized.

Copy link
@peterjc

peterjc Nov 14, 2022

Contributor

Most (although not all) of the bullets here end with a full stop, so how about:

Tabs for indentation (spaces permitted if consistent).

This comment has been minimized.

Copy link
@peterjc

peterjc Nov 14, 2022

Contributor

Actually I make that 2 with a full stop, 2 without, and 2 ending with a colon.

I'd prefer it was consistent, e.g. all ending with a full stop or a colon - but personal style choice.

This comment has been minimized.

Copy link
@hexylena

hexylena Nov 14, 2022

Author Member

Ahh took me a minute to see these are on a commit, not a PR, hence the "make suggestion" button is missing. Yes, indeed, happy to fix english stylistic issues :)

This comment has been minimized.

Copy link
@hexylena

hexylena Nov 14, 2022

Author Member

resolved.

This comment has been minimized.

Copy link
@peterjc

peterjc Nov 14, 2022

Contributor

Ah - I couldn't see the suggestion button either. Cheers.

* Order of XML elements:

* `description`_
Expand Down

0 comments on commit 9c17c4c

Please sign in to comment.