v1.10 ignores double "##"

[mkilchhofer]

Hi @norwoodj

It seems that v1.10.0 introduces a kind of different behavior. In the past we used something like this:

  # -- Define user-defined context
  ## For more information: https://argocd-notifications.readthedocs.io/en/stable/templates/#defining-user-defined-context
  context: {}
    # region: east
    # environmentName: staging

the new version now introduces this change:

-| notifications.context | object | `{}` | Define user-defined context |
+| notifications.context | object | `{}` | Define user-defined context # For more information: https://argocd-notifications.readthedocs.io/en/stable/templates/#defining-user-defined-context |

So in the past lines with two ## were ignored in the rendered README. Is this an intended change?

[mszostok]

The option to ignore the comments is quite useful. Our use-case is to have more info about the format:

  # Using existing Communication secret. It MUST be in the `botkube` Namespace.
  ## Secret format:
  ##  stringData:
  ##    comm_config.yaml: |
  ##      communications:
  ##        # Here specify settings for each app, like Slack, Mattermost etc.
  ##        # NOTE: Use setting format visible below.
  existingSecretName: ""

I hope that it will be added back 🤞

[acolombier]

Any update on this? Are you accepting PR to restore that behaviour?

[norwoodj]

Hey, indeed, Sorry about breaking this behavior, I see the utility of this feature. I would certainly accept a PR to change this back to the old behavior. I just don't have time to do it myself.