ga4gh / task-execution-schemas

Apache License 2.0
80 stars 28 forks source link

Executor.stdout/err docs #62

Closed buchanae closed 6 years ago

buchanae commented 7 years ago

Often during development I've forgotten to set the Executor.stdout/err fields, which left me a bit confused as to why I didn't have logs from my command.

Should these fields be on by default? This would prevent confusion from users who might be as forgetful as me (granted, I am more forgetful than average).

Additionally, why do these fields exist? What is the use case where an executor needs control over the stdout/err path? Should stdout/err paths be an implementation detail? If not, a solid use case will help me write some docs around this.

buchanae commented 7 years ago

Kyle answered my question:

These have paths so that Task.outputs may refer to the paths set in Executor.stdout/err.

The current default of an empty string seems fine, and this is more of a Funnel issue where we can guarantee some logs are always captured.

Leaving this issue open to remind me to write docs around this use case.