summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-12 08:00:42 -0700
committerGitHub <noreply@github.com>2018-07-12 08:00:42 -0700
commiteaa07961cb011ed803bf019e5000f01b550350b3 (patch)
tree152c5461aa4407794d2836764c042fe074a1466c
parent5c240fab0fc4bf8167fb8acc8cea19914e462d3a (diff)
parentcb8f2a4212e82b3ae50bda772391c435c0d4a55a (diff)
downloadchef-eaa07961cb011ed803bf019e5000f01b550350b3.tar.gz
Merge pull request #7452 from chef/yard_cleanup
Add proper yard deprecated tags on methods
-rw-r--r--chef-config/lib/chef-config/path_helper.rb2
-rw-r--r--lib/chef/http/http_request.rb4
2 files changed, 3 insertions, 3 deletions
diff --git a/chef-config/lib/chef-config/path_helper.rb b/chef-config/lib/chef-config/path_helper.rb
index fbb413578a..053c7a3c32 100644
--- a/chef-config/lib/chef-config/path_helper.rb
+++ b/chef-config/lib/chef-config/path_helper.rb
@@ -152,7 +152,7 @@ module ChefConfig
canonical_path(path1) == canonical_path(path2)
end
- # Note: this method is deprecated. Please use escape_glob_dirs
+ # @deprecated this method is deprecated. Please use escape_glob_dirs
# Paths which may contain glob-reserved characters need
# to be escaped before globbing can be done.
# http://stackoverflow.com/questions/14127343
diff --git a/lib/chef/http/http_request.rb b/lib/chef/http/http_request.rb
index 8fec34f8b3..9ee519c8ac 100644
--- a/lib/chef/http/http_request.rb
+++ b/lib/chef/http/http_request.rb
@@ -100,7 +100,7 @@ class Chef
@url.path.empty? ? SLASH : @url.path
end
- # DEPRECATED. Call request on an HTTP client object instead.
+ # @deprecated Call request on an HTTP client object instead.
def call
hide_net_http_bug do
http_client.request(http_request) do |response|
@@ -114,7 +114,7 @@ class Chef
Chef::Config
end
- # DEPRECATED. Call request on an HTTP client object instead.
+ # @deprecated Call request on an HTTP client object instead.
def http_client
@http_client ||= BasicClient.new(url).http_client
end