puppetlabs / puppetlabs/puppet-strings
Support for function `Local Type Aliases`
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 90
- Forks
- 90
- PR merge metrics
- No merged PRs in 30d
Description
Use Case
Functions support Local Type Aliases.
Describe the Solution You Would Like
It's be great if puppet-strings would document these and with links to the generated documentation from the function dispatches that use them
Describe Alternatives You've Considered
Normal type aliases are not synced to agents and prevent calls to a function from being deferred.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked Puppet language specification section on Local Type Aliases and trace how puppet-strings documents function dispatches. Determine how generated documentation should represent these aliases and link them from dispatches that use them; done means the generated documentation includes both the aliases and working links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100