puppetlabs / puppetlabs/puppet-strings
Does not parse %q() delimited strings in Puppet Resource API Types
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
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:
- Change the delimiters for any string in a Resource API type to
%q(...)instead of'...'or"..." pdk bundle exec puppet strings generate --format markdown --out REFERENCE.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue with a Resource API type using a %q(...) description, then run pdk bundle exec puppet strings generate --format markdown --out REFERENCE.md. Trace the string parsing and reference output path; done means the generated Markdown contains the description text without the %q() delimiters.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100