lib/cloud_powers/zenv.rb in cloud_powers-0.2.7.3 vs lib/cloud_powers/zenv.rb in cloud_powers-0.2.7.4
- old
+ new
@@ -89,13 +89,15 @@
@project_root
end
# Manually set the +@project_root+ i-var as a +Pathname+ object.
#
- # Parameters New path to the project root +String+|+Pathname+
+ # Parameters
+ # * +String+|+Pathname+ - new path to the project root
#
- # Returns +Pathname+ - +@project_root+
+ # Returns
+ # +Pathname+ - +@project_root+
#
# Example
# project_root
# # => '/home/ubuntu/cerebrum/'
# project_root = Pathname.new(`pwd`)
@@ -106,11 +108,12 @@
end
# Search through the system environment variables for a key or if no key
# is given, return all the system-env-vars and their values
#
- # Parameters [key <String>]: The key to search for
+ # Parameters
+ # * key +String+ - the key to search for
#
# Returns
# * if a +key+ is given as a parameter, +String+
# * if no +key+ is given as a parameter, +Hash+
# with this structure +{ key => value, ... }+ is returned for all keys with a value.
@@ -143,10 +146,10 @@
#
# Parameters
# * key +String+|+Symbol+ - the key to search for
#
# Returns
- # +String+
+ # * +String+
#
# Notes
# * TODO: implement a search for all 3 that can find close matches
def zfind(key)
project_root if @project_root.nil?