summaryrefslogtreecommitdiff
path: root/lib/chef/resource.rb
diff options
context:
space:
mode:
authorLamont Granquist <lamont@scriptkiddie.org>2019-05-07 14:28:04 -0700
committerLamont Granquist <lamont@scriptkiddie.org>2019-05-07 14:30:53 -0700
commit52a2c0e7092929e46c6765e8797775bc0a38bd9a (patch)
tree7ebe2ff45ac0bd6d79bf7c78fb90176bebf0c115 /lib/chef/resource.rb
parent896c67a9df8b4868e53f716302e382fae40466f2 (diff)
downloadchef-52a2c0e7092929e46c6765e8797775bc0a38bd9a.tar.gz
update outdated description on preview resources
Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
Diffstat (limited to 'lib/chef/resource.rb')
-rw-r--r--lib/chef/resource.rb7
1 files changed, 3 insertions, 4 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb
index 56475af249..fb21ae1064 100644
--- a/lib/chef/resource.rb
+++ b/lib/chef/resource.rb
@@ -1172,10 +1172,9 @@ class Chef
# Set or return if this resource is in preview mode.
#
- # This is used in Chef core as part of the process of migrating resources
- # from a cookbook into core. It should be set to `true` when a cookbook
- # resource is added to core, and then removed (set to `false`) in the next
- # major release.
+ # This only has value in the resource_inspector to mark a resource as being new-to-chef-core.
+ # Its meaning is probably more equivalent to "experimental" in that the API might change even
+ # in minor versions due to bugfixing and is NOT considered "stable" yet.
#
# @param value [nil, Boolean] If nil, get the current value. If not nil, set
# the value of the flag.