dsc_resource: module_name mandatory when module_version is specified.
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
If you specify the module_version parameter, you MUST also specify the module_name parameter as well. However the documentation as currently worded, implies that if module_name is not supplied, the module name will be inferred, suggesting that the property is not mandatory when in fact it is (at least when a module_version is also specified).
The wording should be updated to state that when module_version is specified, then module_name is required.
Per the current documentation:
module_name
Ruby Type: StringThe name of the module from which a DSC resource originates. If this property is not specified, it will be inferred.
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 at the dsc_resource documentation entry and review the module_name and module_version parameter descriptions quoted in the issue. Update the wording to state that module_name is required when module_version is specified, then verify that the rendered documentation accurately reflects this requirement.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100