The current documentation for workflow commands does not mention the input field. This omission could lead listeners or users to assume that user input is not necessary for workflow execution, which can lead to confusion if a workflow actually requires it. To clarify, it would be beneficial to include an explanation indicating that if user input is required for a workflow to execute, the documentation should explicitly state input: required.
Suggested Change:
Update the workflow command yml file to include the input field description, highlighting the conditions under which it is required.
Impact:
This change will help prevent potential confusion, ensuring users understand when input is necessary for a workflow to proceed, thereby improving the overall usability and clarity of workflow documentation.
The current documentation for workflow commands does not mention the
inputfield. This omission could lead listeners or users to assume that user input is not necessary for workflow execution, which can lead to confusion if a workflow actually requires it. To clarify, it would be beneficial to include an explanation indicating that if user input is required for a workflow to execute, the documentation should explicitly stateinput: required.Suggested Change:
inputfield description, highlighting the conditions under which it is required.Impact: