summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2020-05-06 19:13:04 -0700
committerGitHub <noreply@github.com>2020-05-06 19:13:04 -0700
commit6c9175c8b4a44a0f2e44f13b85af512f0617f004 (patch)
tree0cd217bdffd0798e8052fa840e6286df216d65fe
parentd764ddf8422af8cc892a0921ec9baf4404ab8c85 (diff)
parentb60ae6140fd57bb8efef394e6413b53bedc0fe29 (diff)
downloadchef-6c9175c8b4a44a0f2e44f13b85af512f0617f004.tar.gz
Merge pull request #9814 from chef/small-rdoc-fix
Fix a small rdoc formatting bug for `copy_properties_from`.
-rw-r--r--lib/chef/mixin/properties.rb2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/chef/mixin/properties.rb b/lib/chef/mixin/properties.rb
index 94afa4640b..b0bccaac87 100644
--- a/lib/chef/mixin/properties.rb
+++ b/lib/chef/mixin/properties.rb
@@ -340,6 +340,7 @@ class Chef
# can also be overridden). Exclude has priority over include, although the caller is likely better
# off doing the set arithmetic themselves for explicitness.
#
+ # ```ruby
# action :doit do
# # use it inside a block
# file "/etc/whatever.xyz" do
@@ -350,6 +351,7 @@ class Chef
# r = declare_resource(:file, "etc/whatever.xyz")
# r.copy_properties_from(new_resource, :owner, :group, :mode)
# end
+ # ```
#
# @param other [Object] the other object (Chef::Resource) which implements the properties API
# @param includes [Array<Symbol>] splat-args list of symbols of the properties to copy.