Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

dsc_resource: module_name mandatory when module_version is specified. #892

Open
MichaelStankiewicz opened this issue Aug 22, 2017 · 0 comments
Labels
Aspect: Documentation How do we use this project? Component: Chef Infra Client Topic: Resources Chef Infra Client Resources

Comments

@MichaelStankiewicz
Copy link

MichaelStankiewicz commented Aug 22, 2017

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: String

The name of the module from which a DSC resource originates. If this property is not specified, it will be inferred.

@kagarmoe kagarmoe added the Type: Docs Debt For @docs-team. Managing projects, nav, ssg, search, test, and build. label Sep 25, 2019
@kagarmoe kagarmoe added Documentation Topic: Resources Chef Infra Client Resources Component: Chef Infra Client and removed Type: Docs Debt For @docs-team. Managing projects, nav, ssg, search, test, and build. labels Apr 8, 2021
@tas50 tas50 added Aspect: Documentation How do we use this project? and removed Documentation labels May 12, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Aspect: Documentation How do we use this project? Component: Chef Infra Client Topic: Resources Chef Infra Client Resources
Projects
None yet
Development

No branches or pull requests

3 participants