puppetlabs / puppetlabs/puppet-strings
Issue a warning for examples without title
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
puppet-strings supports examples likes:
# @example this is the title
# insert puppet code here
#
puppet-strings ignores missing titles and will then add a bunch of #### into the REFERENCE.md.
Describe the Solution You Would Like
It would be nice if puppet-strings could issue a warning/error if the title for an example is missing and if that could be used in a rake task to validate the puppet files.
Describe Alternatives You've Considered
This is based on https://github.com/voxpupuli/puppet-lint-param-docs/ but I think it would make more sense to have this feature within puppet-strings
Additional Context
Add any other context or screenshots about the feature request here.
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 tracing how @example entries without titles are parsed and rendered into REFERENCE.md. Define how missing titles should be reported and how validation through a rake task should flag them; done when such examples no longer silently produce repeated headings and the validation task reports the problem.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100