Flesh out doctstring for DRMAACluster

[edurand]

As discussed in issue 72, I fleshed out the docstring for DRMAACluster. Hopefully it is now a little bit easier to use.

[maxnoe]

I do not understand why a path would need to start with ":"

[jakirkham]

So don't think the : is necessary, but can be used to specify a file on a different host by prefacing with a hostname or IP IIRC.

[jakirkham]

FWIW normally I'll do something like localhost:my_job.out. Similar story with errorPath.

[maxnoe]

Could you also explain how outputPath and errorPath could be used?

I don't get why a path needs to start with : and how to use templating with the JOB_ID or similar.

[edurand]

I believe the ":" is required by DRMAA to be considered a valid path. I am unsure why.

One possibility would be to allow the user to pass an ouputTemplate and errorTemplate instead of outputPath and errorPath. Then the docstring might look something like

outputTemplate: Template to specify job output path. Must be formatted as 'basename.{jid}.out'. {jid} will be automatically replaced by JOBID.JOBINDEX to avoid multiple jobs writing to the same file. For instance, to have your jobs output to files with basenames /scratch/job_output, specify outputTemplate as "/scratch/job_output.{jid}.out".

How does that look?

[maxnoe]

I like it

[maxnoe]

I think it would be great to go ahead with this doc fix and make a new release with the other recent changes.

[jakirkham]

@edurand, do you have time to fix the merge conflicts?

[jakirkham]

Based on your recent comments @maxnoe, I'm assuming you are happy with this, but just noticed there was an X in the review section. Was there anything else we need to address?

[jakirkham]

Also thanks @edurand for the contribution. The doc refresh was definitely needed. :)