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 if empty line between parameter docs and class/define #17

Open
alexjfisher opened this issue Oct 1, 2020 · 3 comments
Open

Warn if empty line between parameter docs and class/define #17

alexjfisher opened this issue Oct 1, 2020 · 3 comments

Comments

@alexjfisher
Copy link
Member

# @summary an example
#
# @param bar

class foo (
  $bar,
)
{
}

doesn't trigger a warning, but puppet-strings won't see the docs.

@ekohl
Copy link
Member

ekohl commented Oct 2, 2020

Perhaps https://github.com/rodjek/puppet-lint/blob/master/lib/puppet-lint/plugins/check_documentation/documentation.rb should actually be modified to check for that. It now skips all whitespace

@alexjfisher
Copy link
Member Author

That might be a better place for it.

@ekohl
Copy link
Member

ekohl commented Oct 2, 2020

I opened rodjek/puppet-lint#931

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