diff options
| author | Lamont Granquist <lamont@scriptkiddie.org> | 2019-05-07 14:28:04 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2019-05-17 12:10:43 -0700 |
| commit | 6c785c0b69f4a0e9700b26ccb7922be75635f645 (patch) | |
| tree | 4f83baaa062ffad5de5fae11b5b41e5c4f4c15eb | |
| parent | be0fc336d7bcfcaea53fc119450bacfb6b031ee5 (diff) | |
| download | chef-6c785c0b69f4a0e9700b26ccb7922be75635f645.tar.gz | |
update outdated description on preview resources
Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
| -rw-r--r-- | lib/chef/resource.rb | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb index 9d67d1d55b..edc6279fc3 100644 --- a/lib/chef/resource.rb +++ b/lib/chef/resource.rb @@ -1166,10 +1166,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. |