Jira (PUP-10025) puppet describe does not show top-level docs

[David Schmitt (JIRA)]

David Schmitt moved an issue

Puppet / PUP-10025 puppet describe does not show top-level docs Change By: David Schmitt Key: PDK PUP - 945 10025 Project: Puppet Development Kit Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[David Schmitt (JIRA)]

David Schmitt updated an issue

Puppet / PUP-10025 puppet describe does not show top-level docs

Change By: David Schmitt Affects Version/s: PUP 6.9.0 Affects Version/s: PUP 5.5.16

Add Comment

[David Schmitt (JIRA)]

David Schmitt commented on PUP-10025

Re: puppet describe does not show top-level docs this is also tracked in https://github.com/puppetlabs/puppet-resource_api/issues/208

Add Comment

[David Schmitt (JIRA)]

David Schmitt updated an issue

Puppet / PUP-10025

puppet describe does not show top-level docs

Change By: David Schmitt Team: Network Automation

Add Comment

[Jorie Tappa (JIRA)]

Jorie Tappa updated an issue

Puppet / PUP-10025 puppet describe does not show top-level docs

Change By: Jorie Tappa Team: Coremunity

Add Comment

[Jorie Tappa (JIRA)]

Jorie Tappa updated an issue

Puppet / PUP-10025 puppet describe does not show top-level docs

Change By: Jorie Tappa Sprint: Coremunity Grooming

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper commented on PUP-10025

Re: puppet describe does not show top-level docs This might be because puppet requires the top level description to end with a ".", see PUP-2641

Add Comment

[David Schmitt (JIRA)]

David Schmitt commented on PUP-10025

Re: puppet describe does not show top-level docs

PUP-2641 does not happen in 6.10.1 anymore (I've manually removed the last "." from the java_ks type to test): david@davids:~/git/puppetlabs-java_ks$ bundle exec puppet describe --libdir ./lib java_ks | head   java_ks ======= Manages the entries in a java keystore, and uses composite namevars to accomplish the same alias spread across multiple target keystores     Parameters ----------   david@davids:~/git/puppetlabs-java_ks$ puppet --version 6.10.1 david@davids:~/git/puppetlabs-java_ks$ git describe --all --long heads/master-0-gee1531a david@davids:~/git/puppetlabs-java_ks$ and even with a dot at the end of the description (https://github.com/puppetlabs/puppetlabs-panos/blob/7f99a79294ab6601af3d1c3069712e604e85ad13/lib/puppet/type/panos_nat_policy.rb#L6) puppet describe still fails with this panos type: david@davids:~/git/puppetlabs-panos$ bundle exec puppet describe panos_nat_policy --libdir ./lib | head   panos_nat_policy ================       Parameters ----------   - **bi_directional** david@davids:~/git/puppetlabs-panos$ puppet --version 6.10.1 david@davids:~/git/puppetlabs-panos$ git describe --all --long heads/master-0-g7f99a79 david@davids:~/git/puppetlabs-panos$ That got me thinking, and now there is a bugfix at https://github.com/puppetlabs/puppet-resource_api/pull/247/ .

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper commented on PUP-10025

Re: puppet describe does not show top-level docs

I can reproduce 2641 using the rcsrepo example. Maybe there is difference in behavior with single vs multiline description/summaries?

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet / PUP-10025

puppet describe does not show top-level docs

Change By: Josh Cooper Labels: beginner

Add Comment

[David Schmitt (JIRA)]

David Schmitt commented on PUP-10025

Re: puppet describe does not show top-level docs fix was merged in https://github.com/puppetlabs/puppet-resource_api/pull/247

Add Comment

[David Schmitt (JIRA)]

David Schmitt updated an issue

Puppet / PUP-10025

puppet describe does not show top-level docs

Change By: David Schmitt Fix Version/s: PUP 6.y

Add Comment

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Puppet / PUP-10025 puppet describe does not show top-level docs

Change By: Josh Cooper Sprint: Community PRs

Add Comment

This message was sent by Atlassian Jira (v8.13.2#813002-sha1:c495a97)

[Josh Cooper (Jira)]

Josh Cooper updated an issue

Puppet / PUP-10025 puppet describe does not show top-level docs Change By: Josh Cooper Sprint:

Add Comment

[Josh Cooper (Jira)]