user_guide

user_guide copied to clipboard

Clarification needed for the acronym "URI" in the context of RRID

3

https://github.com/common-workflow-language/user_guide/blob/b6c2f66a69f2eb63ba37b9a012eaa73743320701/src/topics/specifying-software-requirements.md?plain=1#L29 Should this be _uniform_ resource identifier? (Although I don't think the RRID has a formal URL scheme or URN namespace yet.)

zoe-translates

In "Inputs" > "Array Inputs", there should be more emphasis on where `inputBinding` appears

1

https://github.com/common-workflow-language/user_guide/blob/499d120c2d16bd41e358ec03a8ed95832a18bff1/src/topics/inputs.md?plain=1#L178-L180 This bit wasn't very clear, because it didn't clarify where "as above" specifically referred to, and what sort of "different behavior[s]" were expected. It's clear that the text meant...

zoe-translates

Clarification needed in "Network Access"

1

https://github.com/common-workflow-language/user_guide/blob/7b71012f6d286fbea44e052a54a1d5977eb9f3ca/src/topics/command-line-tool.md?plain=1#LL70C1-L71C40 > If a command-line tool is written **manually** in CWL v1.1+, there is a need to specify when network access is required. Here is it actually relevant whether "a...

zoe-translates

FAQ entry about referencing local script: "including an input of `type: File` in the script itself"?

1

Am I correct in understanding that the intention here was "including *the script as* an input of `type:File` in *the CWL document* itself"? https://github.com/common-workflow-language/user_guide/blob/dd897f448ef3db0d4528c4e67b387a2cc04752a1/src/faq.md?plain=1#L115-L132 In the context of this entry,...

zoe-translates

Possible wrong ordering of sections in the Topics

2

https://github.com/common-workflow-language/user_guide/blob/dbeb91c9aa4e0343cc129f9986f9482986efe6a3/src/topics/parameter-references.md?plain=1#L3 Here the "previous example" seems to be a reference to `src/topics/outputs.md`. But in the current ordering of sections, `parameter-refernece.md` is Section 2.6 which comes before `outputs.md` at 2.7. It...

zoe-translates

``` bash sphinx-build -b html -D language=ja src _build/html/ja open _build/html/ja/index.html ``` The `sphinx-build` command should apart of a Makefile target that builds all languages

mr-c

Unclear reference of "two commands" in Topics - Inputs

1

https://github.com/common-workflow-language/user_guide/blob/2f88e802c82ba462d10be83edb909da536db1766/src/topics/inputs.md?plain=1#L54-L55 It's unclear what the "two commands" refer to in this context. The "following boxed text" is the example output of the single command `cwltool inp.cwl inp-job.yml`.

zoe-translates

Text consistency: command-line, command line, commandline

1

We have several variations. It would be nice to choose the preferred way, and update our `CONTRIBUTING.md` file (or Wiki, or `README.md`, etc.). We may have to also notify translators...

kinow

1. They must be questions 2. They must not use title format (A Title With Multiple Words), but instead use normal capitalization (A title with multiple words) See also these...

kinow

One major issue blocking our release is the number of commits in the same PR, some not rebased. Looking at the [current `CONTRIBUTING.md`](https://github.com/common-workflow-language/user_guide/blob/1dea5697b67b4750629b1cc60f39a09f262a7c5d/CONTRIBUTING.md#using-github), I think it's not direct about number...

kinow