From 5c32c8e8382d800968225734d06663c1a75d80b2 Mon Sep 17 00:00:00 2001
From: Marcin Owsiany <marcin@owsiany.pl>
Date: Sat, 6 Oct 2007 13:29:17 +0100
Subject: Somewhat better documentation of the :absent field feature in
 fileparsing.

---
 lib/puppet/util/fileparsing.rb | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'lib/puppet/util/fileparsing.rb')

diff --git a/lib/puppet/util/fileparsing.rb b/lib/puppet/util/fileparsing.rb
index 7552e8141..8e39719c8 100644
--- a/lib/puppet/util/fileparsing.rb
+++ b/lib/puppet/util/fileparsing.rb
@@ -268,7 +268,9 @@ module Puppet::Util::FileParsing
 
     # Define a new type of record.  These lines get split into hashes.  Valid
     # options are:
-    # * <tt>:absent</tt>: What to use when a field is absent.  Defaults to "".
+    # * <tt>:absent</tt>: What to use as value within a line, when a field is
+    #   absent.  Note that in the record object, the literal :absent symbol is
+    #   used, and not this value.  Defaults to "".
     # * <tt>:fields</tt>: The list of fields, as an array.  By default, all
     #   fields are considered required.
     # * <tt>:joiner</tt>: How to join fields together.  Defaults to '\t'.
-- 
cgit