Change YAML multiline string style for comments

[sschuberth]

I just realized that the | we're currently using for multiline curation comments adds a trailing newline. This becomes visible as \n as part of the resolved configuration in analyzer results:

  - provider:
      id: "DefaultDir"
    curations:
    - id: "Maven:com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava"
      curations:
        comment: "This library is empty as its version string suggests.\n"
        is_metadata_only: true

This is not so nice. Thus I'm proposing to change comments to use >- instead, which strip the final newline and also folds lines.

Opinions @fviernau, @mnonnenmacher?

[fviernau]

I'd appreciate also inut from @MarcelBochtler as he wrote related code in helper-cli IIRC, like e.g.: oss-review-toolkit/ort@062dd6d

[MarcelBochtler]

I think it was a conscious decision to use | instead of >- because the line breaks should be kept in case the comment is displayed somewhere.

AFAIK this is currently not being done:

• Curations comments are not displayed anywhere
• Resolutions don't adhere the \n when being displayed in the webapp report (It would be an improvement if they actually would):
  

As the analyzer-result.yml file is not meant to be read by humans, I don't really see any benefits by removing this additional information.
However, I don't have a strong opinion about this.

[sschuberth]

We could also use |- as a compromise which does not fold newlines, but strips the final newline.

[fviernau]

Could someone shed a light on why we want to use new lines / line breaks at all?

[sschuberth]

Could someone shed a light on why we want to use new lines / line breaks at all?

See above, what @MarcelBochtler wrote: You might want to have control over the formatting in which comments are display, e.g. if you have a lengthy explanation with paragraphs.

[sschuberth]

We could also use |- as a compromise which does not fold newlines, but strips the final newline.

So, any objection to align on using |-?

[mnonnenmacher]

No objections from me.