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

Plan parameter index may link to wrong parameter when there are duplicates #294

Open
jpartlow opened this issue Dec 16, 2021 · 2 comments
Open
Labels

Comments

@jpartlow
Copy link

Describe the Bug

The generated markdown documentation for a Puppet plan includes an indexed list of plan parameters that link to parameter entries describing each one. If a parameter has the same name across multiple plans or tasks, the index appears to always link to just the parameter name and therefore to just the first instance of where that parameter is first referenced, which may be in another task or plan.

Expected Behavior

Plan parameter index should link to the plan's parameter references.

Steps to Reproduce

You can see this in a generated REFERENCE.md page from pam_tools.
The puppetlabs::teardown plan has a scaledown_timeout parameter. The link in the parameter list links to the parameter under the delete_k8s_app_resources task instead.

Environment

  • Version 2.9.0
  • Platform Ubuntu 18.04

Additional Context

Add any other context about the problem here.

@danielparks
Copy link
Contributor

Looks like I duplicated this when I filed #300 (the issue is more general than just plans).

That said, I’m surprised that it generates plan documentation at all, since currently that test fails on this repo (#307).

@danielparks
Copy link
Contributor

Should be fixed now by #303

@chelnak chelnak added the bug label Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants