is our block description syntax valid yaml?

currently, we allow rule authors to add a description to and/or/etc. like so:

and:
  - match: foo
  - match: bar
  description: this is awesome!

(concrete example here)

this seemed like a natural way to extend our two-line syntax for feature descriptions, which look like:

and:
  - string: foo
    description: bar

however, i’m not sure that the former is valid yaml. ruamel accepts it, but pyyaml does not. take a moment to look at it and try to figure out how it should be parsed? is the child of the and a list or dictionary???

[re-fox]

I agree! That sounds like a good plan.

I remember at the time, modifying the rule several times before I found a working variation. I think that’s how I ended up on.

  - api: foo
  description: bar

In my opinion it’s better to have commented descriptions than none at all. Those can always be uncommented and fixed up later.

[mr-tz]

Yeah, let’s fix this. Commenting out is a good start!