From 74bb8fb3480d0b0acaa6ef0bb93cc990cc7bf639 Mon Sep 17 00:00:00 2001 From: Burdette Lamar Date: Mon, 4 Nov 2019 17:03:01 -0600 Subject: More rdoc for ENV --- hash.c | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'hash.c') diff --git a/hash.c b/hash.c index 0eb101e04a..8cc450f0f3 100644 --- a/hash.c +++ b/hash.c @@ -6214,6 +6214,34 @@ Init_Hash(void) /* Document-class: ENV * * ENV is a hash-like accessor for environment variables. + * + * === Interaction with the Operating System + * The ENV object interacts with the operating system's environment variables: + * - When you get the value for a name in ENV, the value is retrieved from among the current environment variables. + * - When you create or set a name-value pair in ENV, the name and value are immediately set in the environment variables. + * - When you delete a name-value pair in ENV, it is immediately deleted from the environment variables. + * === Names and Values + * Generally speaking, each name or value is a String. + * + * Strictly speaking: + * - Each name or value must be one of the following: + * - A String. + * - An object that responds to #to_str by returning a String, which will be used as the name or value. + * - A name may not: + * - Be the empty string. + * - Contain character = or the NUL character ("\0"). + * - Have an ASCII-incompatible encoding (e.g., UTF-16LE, ISO-2022-JP). + + * === About Ordering + * ENV presents its content in the order found + * in the operating system's environment variables. + * Therefore the ordering of ENV content is OS-dependent, and may be indeterminate. + * + * This will be seen in: + * - A Hash returned by an ENV method. + * - An Enumerator returned by an ENV method. + * - An Array returned by ENV.keys, ENV.values, or ENV.to_a. + * - The String returned by ENV.inspect. */ /* -- cgit v1.2.3