Maybe a problem with the note section for array call of package resource
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
On line 498 of the package resource there's this note line:
.. note:: Notifications and subscriptions do not need to be updated when packages and versions are added or removed from the
package_nameorversionproperties.
I think it's half true, and could maybe be reworded as:
`.. note:: Notifications and subscriptions do not need to be updated when pacakges versions are updated in the version properties but must be updated if the list of packages changes.
Or keeping the note as is thenthe exemple above should be
package 'my_stack' do
package_name %w(package1 package2)
version [ '1.3.4-2', '4.3.6-1']
action :nothing
end
log 'call a notification' do
notifies :install, 'package[my_stack]', :immediately
end
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
Open chef_master/source/resource_package.rst around line 498 and compare the note with the package resource example immediately around it. Check whether notifications and subscriptions behave differently when package names versus versions change, then update the note or example so they agree and correct the wording.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100