Skip to content

exec type in generated docs missing attributes creates, onlyif #229

@jbondpdx

Description

@jbondpdx

Describe the Bug

In generated Puppet reference documentation, the exec type is missing information for the creates and onlyif attributes

Expected Behavior

Generated docs should include both attribute descriptions, and the attributes should also appear at the code block at the top of the page, without manual intervention. (See https://puppet.com/docs/puppet/latest/types/exec.html , the attributes were added manually after generation)

Steps to Reproduce

Steps to reproduce the behavior:

  1. Within the puppet-docs repo, run the internal docs generation command: bundle exec rake references:puppet VERSION=6.14.0
  2. Diff the generated doc from puppet-docs/reference_output/puppet/types/exec.md against the existing documentation in puppet-docs/source/puppet/latest/types/exec.md

Environment

cloned puppet-docs repo, *nix

Additional Context

The generation command retrieves a vendored copy of the Puppet codebase; there's a setting you can change to have it use a Puppet codebase on your machine, if you need to test documentation changes sourced from the Puppet code itself. (I don't think this issue will require that, though.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions