Skip to content

Commit 1282fe0

Browse files
authored
Various cleanup refactoring (#86)
* adding a curl alias so we don't have to specify the timeout options each time * remove turtle eye code since it's not used * fix typos * fix intellij complaints: always use [[]], and ${} * add a conventions section to the readme
1 parent a400bd5 commit 1282fe0

File tree

2 files changed

+158
-154
lines changed

2 files changed

+158
-154
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ requires `column`, `curl`, `mail`, and [jq](https://stedolan.github.io/jq/)
9494
* Running `submit` will create a new folder in the `~/.cromshell/${CROMWELL_URL}/` directory named with the cromwell job id of the newly submitted job.
9595
It will copy your wdl and json inputs into the folder for reproducibility.
9696
* It keeps track of your most recently submitted jobs by storing their ids in `./cromshell/`
97-
You may ommit the job ID of the last job submitted when running commands, or use negative numbers to reference previous jobs, e.g. "-1" will track the last job, "-2" will track the one before that, and so on.
97+
You may omit the job ID of the last job submitted when running commands, or use negative numbers to reference previous jobs, e.g. "-1" will track the last job, "-2" will track the one before that, and so on.
9898
* You can override the default cromwell server by setting the environmental variable `CROMWELL_URL` to the appropriate URL.
9999
* Most commands takes multiple workflow-ids, which you *can specify both in relative and absolute ID value* (i.e. `./cromwell status -1 -2 -3 c2db2989-2e09-4f2c-8a7f-c3733ae5ba7b`).
100+
101+
### Code Conventions:
102+
Please try to follow these conventions when editing cromshell.
103+
* Use double brackets for tests ( `[[ ... ]]` instead of `[]`)
104+
* Use `{}` when doing dereferencing variables (`${VALUE}`,`${1}` instead of `$VALUE`,`$1`)
105+
* Define functions with the `function` keyword (`function doThing()` instead of `doThing()`)

0 commit comments

Comments
 (0)