search

puppetlabs / puppet-strings

The next generation Puppet documentation extraction and presentation tool.
http://puppetlabs.github.io/puppet-strings/
Apache License 2.0
90 stars 84 forks source link

Does not parse %q() delimited strings in Puppet Resource API Types #263

Open michaeltlombardi opened 4 years ago

michaeltlombardi commented 4 years ago

Describe the Bug

A multiline description in the type definition of a resource which includes both single ' and double " quotes should be delimited by %q() - but this puts the literal string in the reference doc, including the %q() delimiters.

Expected Behavior

A validly delimited string should be written into the reference output without showing the delimiters.

Steps to Reproduce

Steps to reproduce the behavior:

  1. Change the delimiters for any string in a Resource API type to %q(...) instead of '...' or "..."
  2. pdk bundle exec puppet strings generate --format markdown --out REFERENCE.md