puppetlabs / puppetlabs/puppet-strings
Writes the delimiters for an empty attribute description
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Describe the Bug
If a Puppet Resource API type attribute has an empty description of '' or "" then that is literally what will be placed in the output instead of nil/an empty line.
Expected Behavior
A type attribute with an empty string for a description writes an empty line under its header and type.
Steps to Reproduce
- Change the descriptor of any attribute in a Puppet Resource API Type to an empty string.
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
Run pdk bundle exec puppet strings generate --format markdown --out REFERENCE.md with a Puppet Resource API type attribute whose descriptor is an empty string, then inspect the generated reference output. Trace how the attribute description is rendered under its header and type; done means empty descriptions produce an empty line rather than the literal quote 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
- 50/100