CircleCI Ideas

Respect Multiline Strings in Orb descriptions in the registry

I have been trying to use multi-line (https://yaml-multiline.info/) `description` fields in my Orb file, but it seems that all newlines are striped from the `description`. This makes my documentation really difficult to read (It's a giant text blob).

 

Example - https://circleci.com/orbs/registry/orb/hutson/library-release-workflows#jobs-python-deploy

  • Avatar32.5fb70cce7410889e661286fd7f1897de Guest
  • Dec 11 2018
  • Candidate
  • Attach files
  • Avatar40.8f183f721a2c86cd98fddbbe6dc46ec9
    Guest commented
    14 Dec, 2018 08:37am

    Agree this is bad - this is slated to be worked on "soon" (CircleCI folks, for internal reference, this is CIRCLE-15300)