search

common-workflow-language / user_guide

The CWL v1.0 - v1.2 user guide
http://www.commonwl.org/user_guide/
Other
41 stars 67 forks source link

Adding more text for exclusive vs inclusive parameters and added diagram #384

Open acoleman2000 opened 1 year ago

acoleman2000 commented 1 year ago

This pull request is based on this issue.

Add clarifying information about exclusive vs inclusive parameters, as well as including a diagram to illustrate the difference.

Upfront described how cwltool handles exclusive vs inclusive parameters, so user can follow along better with examples.

zoe-translates commented 1 year ago

Thank you @acoleman2000 for this!

One more thing I noticed while doing the translation work in this section.

Here we have the word "inclusive" in the section subtitle. That's the only place this word appears in this section (without this PR). It appears to me that the word was being used interchangeably with "dependent". The term "dependent is used in the FAQ, where "inclusive" doesn't appear there.

In fact, running ag -iG '^.+\.md$' 'inclusive' in the src directory (i.e. print all occurrence of the word "inclusive" in markdown files), the only hit is this one here.

I think what this means is that we have reason to do away with the word "inclusive" here and replace it with "dependent".

zoe-translates commented 1 year ago

The rendered HTML with the image and the new text are looking great! Left some comments about the markdown text.

The RTD build is failing. I tried to have a look but couldn't understand what's going on, so I'll revisit it later.

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/common-workflow-languageuser-guide/envs/384/lib/python3.9/site-packages/sphinx/config.py", line 350, in eval_config_file
    exec(code, namespace)
  File "/home/docs/checkouts/readthedocs.org/user_builds/common-workflow-languageuser-guide/checkouts/384/src/conf.py", line 257, in <module>
    from myst_parser.mdit_to_docutils.sphinx_ import SphinxRenderer, create_warning
ImportError: cannot import name 'create_warning' from 'myst_parser.mdit_to_docutils.sphinx_' (/home/docs/checkouts/readthedocs.org/user_builds/common-workflow-languageuser-guide/envs/384/lib/python3.9/site-packages/myst_parser/mdit_to_docutils/sphinx_.py)

This should be fixed by f940a62fdc9f4381cb88288b6ea02acdd970960f. A rebase should fix the build error.