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.

Sign up for GitHub

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

Jump to bottom

[Feature] Document functions in Puppet Datatypes #225

Closed
glennsarti opened this issue Apr 3, 2020 · 0 comments · Fixed by #235
Closed

[Feature] Document functions in Puppet Datatypes #225

glennsarti opened this issue Apr 3, 2020 · 0 comments · Fixed by #235

Comments

@glennsarti
Copy link
Contributor

Use Case

In Pull Request #199 only Datatype attributes were added. Datatype functions should also be documented

Describe the Solution You Would Like

Puppet-strings should document data type functions like a regular function

Describe Alternatives You've Considered

N/A

Additional Context

The Bolt core libraries use functions e.g.
https://github.com/puppetlabs/bolt/blob/master/bolt-modules/boltlib/lib/puppet/datatypes/target.rb
@glennsarti glennsarti mentioned this issue Apr 3, 2020
Closed
7 tasks
glennsarti added a commit to glennsarti/puppet-strings that referenced this issue Apr 9, 2020
@glennsarti
wip(puppetlabsGH-225) Document functions in Puppet Datatypes
2253e5c
glennsarti added a commit to glennsarti/puppet-strings that referenced this issue May 25, 2020
@glennsarti
wip(puppetlabsGH-225) Document functions in Puppet Datatypes
666fce6
glennsarti added a commit to glennsarti/puppet-strings that referenced this issue May 30, 2020
@glennsarti
wip(puppetlabsGH-225) Document functions in Puppet Datatypes
5e4973b
@glennsarti glennsarti mentioned this issue May 30, 2020
Merged
7 tasks
glennsarti added a commit to glennsarti/puppet-strings that referenced this issue May 30, 2020
@glennsarti
wip(puppetlabsGH-225) Document functions in Puppet Datatypes
2a41599
glennsarti added a commit to glennsarti/puppet-strings that referenced this issue May 30, 2020
@glennsarti
(puppetlabsGH-225) Document functions in Puppet Datatypes
1900b26 
Previously the puppet datatype handler only documented attributes, not functions
for example [1].  This commit updates the data type handler to read in the
function information and then allow that to be used by puppet-strings in its
JSON, Markdown and HTML renderers.  This commit also adds tests for many
different scenarios and all three rendering types.

[1] https://github.com/puppetlabs/puppet/blob/3e03e734dda415272ec156b03ed9f021ba243228/lib/puppet/datatypes/error.rb#L13-L15
scotje added a commit that referenced this issue Jun 15, 2020
@scotje
Merge pull request #235 from glennsarti/gh225-datatype-functions
a76dd4c 
(GH-225) Document functions in Puppet Datatypes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@scotje @glennsarti