comment permalink

comment your pipeline code permalink

Similar to code comments, comment is for pipeline authors to annotate a pipeline step for the usual reasons. Like remembering why on earth you did something in a certain way two weeks later.

comment does not output at run-time ever. If you’re looking to add descriptive text that prints to output for pipeline consumer visibility, use description instead.

- name: pypyr.steps.contextsetf
  comment: this comment is for pipeline authors.
           it is multi-line to prove a point.
           it probably describes a technical point
           about why the step is doing something.
      newKey: 'XXX {invalue} XXX'

| yaml comment: arb text

see also

last updated on .