client.rb in chef-api-0.2.1

- old
+ new

@@ -24,11 +24,11 @@
       #   the path to the client on disk
       #
       # @return [Resource::Client]
       #
       def from_file(path)
-        name, contents = Util.safe_read(path)
+        name, key = Util.safe_read(path)
 
         if client = fetch(name)
           client.private_key = key
           client
         else
@@ -61,18 +61,16 @@
     #
     # @example Regenerate the private key
     #   key = client.regenerate_key
     #   key #=> "-----BEGIN PRIVATE KEY-----\nMIGfMA0GCS..."
     #
-    # @warn
-    #   For security reasons, you should perform this operation sparingly! The
-    #   resulting private key is committed to this object, meaning it is saved
-    #   to memory somewhere. You should set this resource's +private_key+ to
-    #   +nil+ after you have committed it to disk and perform a manual GC to
+    # @note For security reasons, you should perform this operation sparingly!
+    #   The resulting private key is committed to this object, meaning it is
+    #   saved to memory somewhere. You should set this resource's +private_key+
+    #   to +nil+ after you have committed it to disk and perform a manual GC to
     #   be ultra-secure.
     #
-    # @warn
-    #   Regenerating the private key also regenerates the public key!
+    # @note Regenerating the private key also regenerates the public key!
     #
     # @return [self]
     #   the current resource with the new public and private key attributes
     #
     def regenerate_keys