You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# @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.
It sure would be nice for puppet-strings to be able to be told to fail for warnings (similar to how puppet-lint can be configured) and for undocumented bits. We are currently having to work around the limitations of puppet-strings with this in a GitHub Action:
Use Case
puppet-strings supports examples likes:
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.
The text was updated successfully, but these errors were encountered: