Skip to content

Issue a warning for examples without title #290

Open
@bastelfreak

Description

@bastelfreak

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions