Skip to content

Add section about exclusive params with expressions, and emphasize command output lines #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 10, 2022

Conversation

kinow
Copy link
Member

@kinow kinow commented Sep 6, 2022

Closes #162

Emphasizes command output lines of interest for users reading the text.

Renames “Advanced Inputs” to “Inclusive and Exclusive Inputs”. I thought it made sense as that section is specifically about these two variations of arguments. I realized a better name could be useful after reading the TODO notes, where we have future content for this section that could be considered advanced too, but I think it would be best to use separate sections. What others think?

Adds a new section below the “Inclusive and Exclusive Inputs”, called ”Exclusive Input Parameters with Expressions”, using an example similar to what is described in #162.

@kinow
Copy link
Member Author

kinow commented Sep 6, 2022

The first commit updates the existing docs to emphasize the lines of interest in the command output. See the before and after below:

1/

image
image

2/

image
image

3/

image
image

I did that because I didn't see the warning in the second code block, where the important part is “record-job2.yml:6:3: Warning: invalid field itemD, expected one of: 'itemC'”.

@kinow
Copy link
Member Author

kinow commented Sep 6, 2022

Suggestion to rename the Advanced Inputs section to Include and Exclusive Inputs

image

Rationale: In the future we might add new sub-sections to the Inputs section. Some could be considered Advanced Inputs too?

image

@kinow kinow marked this pull request as ready for review September 6, 2022 01:24
@kinow kinow changed the title Add note about exclusive params with expressions, and emphasize command output lines Add section about exclusive params with expressions, and emphasize command output lines Sep 6, 2022
@kinow
Copy link
Member Author

kinow commented Sep 6, 2022

Added new section about exclusive params with expressions, preview available here: https://common-workflow-languageuser-guide--247.org.readthedocs.build/en/247/topics/inputs.html#exclusive-input-parameters-with-expressions

Copy link
Member

@mr-c mr-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, I quite like this; thanks!

@kinow kinow force-pushed the exclusive-params-with-expressions branch from 319a00c to 04dd944 Compare September 6, 2022 21:28
@mr-c mr-c enabled auto-merge (squash) October 10, 2022 09:55
@mr-c mr-c merged commit 50d824f into main Oct 10, 2022
@mr-c mr-c deleted the exclusive-params-with-expressions branch October 10, 2022 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example for using expressions with exclusive parameters
2 participants