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

Sensu2 strings docs #925

Merged
merged 3 commits into from
Jun 27, 2018
Merged

Sensu2 strings docs #925

merged 3 commits into from
Jun 27, 2018

Conversation

treydock
Copy link
Collaborator

Pull Request Checklist

Description

Ensure all classes and types have documentation that is compatible with Puppet strings.
Also some minor cleanup of commented out code in sensu_check.

Related Issue

Relates to #901

Motivation and Context

All classes and types should have proper documentation.

How Has This Been Tested?

bundle exec rake strings:generate - the only warnings are unused code that is removed in #924

General

  • New parameters are documented

  • New parameters have tests

  • Tests pass - bundle exec rake validate lint spec

@ghoneycutt ghoneycutt assigned ghoneycutt and unassigned ghoneycutt Jun 26, 2018
@ghoneycutt ghoneycutt self-requested a review June 26, 2018 22:28
@treydock
Copy link
Collaborator Author

Came across this some time ago: https://groups.google.com/d/msg/puppet-users/W2Vv4vrvOcY/N6KMkq3WDAAJ. The site puppetmodule.info that hosts puppet strings output.

Also, 4 properties in sensu_check are undocumented because they exist in Go but not on sensu documentation website. I wanted the description to match documentation, should we file a bug with sensu-docs repo?

@ghoneycutt
Copy link
Collaborator

Good catch! We should match the documentation. If the documentation is not accurate to the code, please do file bugs.

@ghoneycutt
Copy link
Collaborator

Two of the acceptance tests timed out, else they were are good. Merging.

@ghoneycutt ghoneycutt merged commit 6a0ef7d into sensu:sensu2 Jun 27, 2018
@treydock treydock deleted the sensu2-strings-docs branch June 27, 2018 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants