Wrong enclosure for data type with multiple lines at markdown

[crazymind1337]

Describe the Bug

If I add a data type with mutliple line, it will be enclosured with single "`" (inline code section) instead of tripple "`" (multi-line code fences). This causes a strange view at a markdownv viewer.

Expected Behavior

It should be enclosed with \n<text>\n

Expected result:

Alias of

\```
Hash[Pattern[/^[a-z][a-z0-9_-]*$/], Struct[
    {
      param1 => String[1],
      param2 => Stdlib::Absolutepath,
      paramX => Boolean,
    }
  ]
]
\```

Steps to Reproduce

Steps to reproduce the behavior:

1. add a custom data type, e.g.:

# summary Test Type
#
type Test_module::Test_type = Hash[
  Pattern[/^[a-z][a-z0-9_-]*$/],
  Struct[
    {
      param1 => String[1],
      param2 => Stdlib::Absolutepath,
      paramX => Boolean,
    }
  ]
]

2. generate the REFERENCE.md:

puppet strings generate --format markdown --out REFERENCE.md

3. check the result, it will be like:

Alias of `Hash[Pattern[/^[a-z][a-z0-9_-]*$/], Struct[
    {
      param1 => String[1],
      param2 => Stdlib::Absolutepath,
      paramX => Boolean,
    }
  ]]`

Environment

• Gem puppet-strings (2.3.1)
• Platform MacOS 10.15.3 (19D76)

[binford2k]

I've reproduced this issue with the example case provided and puppet-strings 2.5.0. Thanks for letting us know @crazymind1337!

[danielparks]

Looks like this is already in place for data type aliases, but it would be nice to extend that to default values and data types where we can. I have a branch that fixes this: danielparks/puppet-strings@better_public_private...danielparks:puppet-strings:multiline_code_blocks (it’s waiting on PR #314, my unsubmitted fix for #240, and possibly PUP-11632).

Also, thanks @crazymind1337, I was surprised that I couldn’t just use a multiline Variant type as a test case, so I used your example.

[danielparks]

Oh, I just figured out that I can link to a commit at the end of a branch without specifying the actual hash. Cool!

danielparks@multiline_code_blocks

[danielparks]

Change merged!

[crazymind1337]

Thanks