Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warn on unrecognised puppet-strings tags #26

Open
alexjfisher opened this issue Oct 6, 2020 · 1 comment
Open

Warn on unrecognised puppet-strings tags #26

alexjfisher opened this issue Oct 6, 2020 · 1 comment

Comments

@alexjfisher
Copy link
Member

This quite possibly belongs in a different plugin, but some of the issues I've come across include...

Capitalisation of tags. eg.

# @Summary This class installs foo
#

Someone meant to use @summary but used @profile instead.

# @profile This profile installs foo
#

Using the name of a parameter as a tag instead of @param

# @ensure Whether to install or remove foo
@ekohl
Copy link
Member

ekohl commented Oct 6, 2020

It doesn't feel appropriate here. Perhaps we need a new puppet-lint-puppet-strings that parses docs and warns on the errors it generates?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants