about summary refs log tree commit diff
diff options
context:
space:
mode:
authorNicolas Pierron <nicolas.b.pierron@gmail.com>2009-11-07 16:24:11 +0000
committerNicolas Pierron <nicolas.b.pierron@gmail.com>2009-11-07 16:24:11 +0000
commitd791b830aa967ed3ed960674bdd8785ad209a645 (patch)
tree09ea6a754f0f7c4285c27c4e51e8aa931434d325
parentb901c0e80833d385cc5fc78aa441b343bc1b8645 (diff)
* Fix typo and clarify why you should not use "mkFixStrictness" on top of
  plain list or attribute set.

svn path=/nixpkgs/trunk/; revision=18260
-rw-r--r--pkgs/lib/properties.nix14
1 files changed, 8 insertions, 6 deletions
diff --git a/pkgs/lib/properties.nix b/pkgs/lib/properties.nix
index c7e6a336ee794..5950ec54791f5 100644
--- a/pkgs/lib/properties.nix
+++ b/pkgs/lib/properties.nix
@@ -454,17 +454,19 @@ rec {
   # properties on top of the option definition is nice for user manipulation
   # but require to check if the content of the property is not another
   # property.  Such testing implies to verify if this is an attribute set
-  # and if it possess the type "property". (see isProperty & typeOf)
+  # and if it possess the type 'property'. (see isProperty & typeOf)
   #
   # To avoid strict evaluation of option definitions, 'mkFixStrictness' is
-  # introduced.  This property protect the option definition by replacing
+  # introduced.  This property protects an option definition by replacing
   # the base of the stack of properties by 'mkNotDef', when this property is
   # evaluated it returns the original definition.
   #
-  # This property is useful over any elements which may depends on an
-  # options which may raise an error if it gets evaluated whitout the proper
-  # settings.  You do not need to use this on top of plain list or attribute
-  # set.
+  # This property is useful over any elements which depends on options which
+  # are raising errors when they get evaluated without the proper settings.
+  #
+  # Plain list and attribute set are lazy structures, which means that the
+  # container gets evaluated but not the content.  Thus, using this property
+  # on top of plain list or attribute set is pointless.
   #
   # This is a Hack, you should avoid it!