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

Refactor inline documentation to puppet strings (yard) format #757

Closed
jeffmccune opened this issue Jul 18, 2017 · 2 comments
Closed

Refactor inline documentation to puppet strings (yard) format #757

jeffmccune opened this issue Jul 18, 2017 · 2 comments
Assignees

Comments

@jeffmccune
Copy link
Collaborator

After #756 and #682 are merged, the inline documentation needs to be updated to the new puppet strings format. This format is described at https://github.com/puppetlabs/puppet-strings/blob/master/README.md

Potentially out of scope, but helper methods for types and providers should be moved into the PuppetX namespace and have documentation added.

@alvagante
Copy link
Collaborator

@ghoneycutt going to start with this, so that I learn better the module params ;-)
Can't self assign it, anyway.

alvagante added a commit to alvagante/sensu-puppet that referenced this issue Aug 11, 2017
Mass conversion of manifests

Fixed puppet-trings warnings

Minors

Minor

Added params lists to types

Removed redundant params list in types (for puppet strings)

Mass conversion of manifests

Fixed puppet-trings warnings

Minors

Minor

Added params lists to types

Removed redundant params list in types (for puppet strings)

More strings edits
alvagante added a commit to alvagante/sensu-puppet that referenced this issue Aug 11, 2017
Docs in puppet-strings format sensu#757

Mass conversion of manifests

Fixed puppet-trings warnings

Minors

Minor

Added params lists to types

Removed redundant params list in types (for puppet strings)

More strings edits

Fixed spec tests
alvagante added a commit to alvagante/sensu-puppet that referenced this issue Aug 11, 2017
Docs in puppet-strings format sensu#757

Mass conversion of manifests

Fixed puppet-trings warnings

Minors

Minor

Added params lists to types

Removed redundant params list in types (for puppet strings)

More strings edits

Fixed spec tests

Fixed some of the added data types
alvagante added a commit to alvagante/sensu-puppet that referenced this issue Aug 11, 2017
Mass conversion of manifests

Fixed puppet-trings warnings

Minors

Minor

Added params lists to types

Removed redundant params list in types (for puppet strings)

More strings edits

Fixed spec tests

Fixed some of the added data types

Fix heap_size validation
ghoneycutt added a commit that referenced this issue Aug 14, 2017
@alvagante
Copy link
Collaborator

#792 merged, ticket can be closed.

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