summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2021-02-03 16:48:00 -0800
committerTim Smith <tsmith84@gmail.com>2021-02-03 16:49:14 -0800
commit37b4b7fca477043d625c798721f49b2924d76bdc (patch)
treebd55cff14409e7ecbe896983d5e20c912b2cb1e1
parent0468affb2a4a00784fe8f9535a35301f4c0c7762 (diff)
downloadchef-better_helper_descriptions.tar.gz
Improve chef-utils helper descriptionsbetter_helper_descriptions
These are used when building out descriptions in the vscode plugin so getting them right is important Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--chef-utils/lib/chef-utils/dsl/cloud.rb20
-rw-r--r--chef-utils/lib/chef-utils/dsl/windows.rb2
2 files changed, 11 insertions, 11 deletions
diff --git a/chef-utils/lib/chef-utils/dsl/cloud.rb b/chef-utils/lib/chef-utils/dsl/cloud.rb
index 9d4de55656..a232563709 100644
--- a/chef-utils/lib/chef-utils/dsl/cloud.rb
+++ b/chef-utils/lib/chef-utils/dsl/cloud.rb
@@ -23,7 +23,7 @@ module ChefUtils
module Cloud
include Internal
- # Determine if the current node is "in the cloud".
+ # Determine if the current node is running in a known cloud.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -35,7 +35,7 @@ module ChefUtils
!node["cloud"].nil?
end
- # Return true if the current current node is in EC2.
+ # Determine if the current node is running in AWS EC2.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -46,7 +46,7 @@ module ChefUtils
node.key?("ec2")
end
- # Return true if the current current node is in GCE.
+ # Determine if the current node running in Google Compute Engine (GCE).
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -57,7 +57,7 @@ module ChefUtils
node.key?("gce")
end
- # Return true if the current current node is in Rackspace.
+ # Determine if the current node is running in Rackspace.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -68,7 +68,7 @@ module ChefUtils
node.key?("rackspace")
end
- # Return true if the current current node is in Eucalyptus.
+ # Determine if the current node is running in Eucalyptus.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -81,7 +81,7 @@ module ChefUtils
# chef-sugar backcompat method
alias_method :euca?, :eucalyptus?
- # Return true if the current current node is in Linode.
+ # Determine if the current node is running in Linode.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -92,7 +92,7 @@ module ChefUtils
node.key?("linode")
end
- # Return true if the current current node is in OpenStack.
+ # Determine if the current node is running in OpenStack.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -103,7 +103,7 @@ module ChefUtils
node.key?("openstack")
end
- # Return true if the current current node is in Azure.
+ # Determine if the current node is running in Microsoft Azure.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -114,7 +114,7 @@ module ChefUtils
node.key?("azure")
end
- # Return true if the current current node is in DigitalOcean.
+ # Determine if the current node is running in DigitalOcean.
#
# @param [Chef::Node] node the node to check
# @since 15.8
@@ -127,7 +127,7 @@ module ChefUtils
# chef-sugar backcompat method
alias_method :digitalocean?, :digital_ocean?
- # Return true if the current current node is in SoftLayer.
+ # Determine if the current node is running in SoftLayer (IBM Cloud).
#
# @param [Chef::Node] node the node to check
# @since 15.8
diff --git a/chef-utils/lib/chef-utils/dsl/windows.rb b/chef-utils/lib/chef-utils/dsl/windows.rb
index dc8cd4ebc0..be6a5c4b83 100644
--- a/chef-utils/lib/chef-utils/dsl/windows.rb
+++ b/chef-utils/lib/chef-utils/dsl/windows.rb
@@ -58,7 +58,7 @@ module ChefUtils
node["kernel"]["product_type"] == "Server"
end
- # Determine the current Windows NT version. The NT version often differs from the marketing version, but offers a good way to find desktop and server releases that are based on the same codebase. IE: NT 6.3 is Windows 8.1 and Windows 2012 R2.
+ # Determine the current Windows NT version. The NT version often differs from the marketing version, but offers a good way to find desktop and server releases that are based on the same codebase. For example NT 6.3 corresponds to Windows 8.1 and Windows 2012 R2.
#
# @param [Chef::Node] node the node to check
# @since 15.8