summary refs log tree commit diff
path: root/lib/customisation.nix
diff options
context:
space:
mode:
authorYoshiRulz <OSSYoshiRulz@gmail.com>2023-01-02 07:51:54 +1000
committerYoshiRulz <OSSYoshiRulz@gmail.com>2023-01-02 08:25:17 +1000
commit7fba83890ccf9f2e10a665bb5a7cc9438280742d (patch)
tree8b53d2e43d21ae132af6856805b4791dc5d91a84 /lib/customisation.nix
parent942fe7ae60e92c2e00b313aad1dfdbaf4cb9f791 (diff)
downloadnixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar.gz
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar.bz2
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar.lz
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar.xz
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.tar.zst
nixpkgs-7fba83890ccf9f2e10a665bb5a7cc9438280742d.zip
lib: Fix mismatched quotes in `lib.*` doc comments
caused problems for automated rich text generation such as
https://teu5us.github.io/nix-lib.html#customisation-functions
Diffstat (limited to 'lib/customisation.nix')
-rw-r--r--lib/customisation.nix22
1 files changed, 11 insertions, 11 deletions
diff --git a/lib/customisation.nix b/lib/customisation.nix
index 7ba8ed06180..101c9e62b9e 100644
--- a/lib/customisation.nix
+++ b/lib/customisation.nix
@@ -3,13 +3,13 @@
 rec {
 
 
-  /* `overrideDerivation drv f' takes a derivation (i.e., the result
-     of a call to the builtin function `derivation') and returns a new
+  /* `overrideDerivation drv f` takes a derivation (i.e., the result
+     of a call to the builtin function `derivation`) and returns a new
      derivation in which the attributes of the original are overridden
-     according to the function `f'.  The function `f' is called with
+     according to the function `f`.  The function `f` is called with
      the original derivation attributes.
 
-     `overrideDerivation' allows certain "ad-hoc" customisation
+     `overrideDerivation` allows certain "ad-hoc" customisation
      scenarios (e.g. in ~/.config/nixpkgs/config.nix).  For instance,
      if you want to "patch" the derivation returned by a package
      function in Nixpkgs to build another version than what the
@@ -104,10 +104,10 @@ rec {
       else result;
 
 
-  /* Call the package function in the file `fn' with the required
+  /* Call the package function in the file `fn` with the required
     arguments automatically.  The function is called with the
-    arguments `args', but any missing arguments are obtained from
-    `autoArgs'.  This function is intended to be partially
+    arguments `args`, but any missing arguments are obtained from
+    `autoArgs`.  This function is intended to be partially
     parameterised, e.g.,
 
       callPackage = callPackageWith pkgs;
@@ -116,9 +116,9 @@ rec {
         libbar = callPackage ./bar.nix { };
       };
 
-    If the `libbar' function expects an argument named `libfoo', it is
+    If the `libbar` function expects an argument named `libfoo`, it is
     automatically passed as an argument.  Overrides or missing
-    arguments can be supplied in `args', e.g.
+    arguments can be supplied in `args`, e.g.
 
       libbar = callPackage ./bar.nix {
         libfoo = null;
@@ -255,13 +255,13 @@ rec {
     in lib.deepSeq drv' drv';
 
   /* Make a set of packages with a common scope. All packages called
-     with the provided `callPackage' will be evaluated with the same
+     with the provided `callPackage` will be evaluated with the same
      arguments. Any package in the set may depend on any other. The
      `overrideScope'` function allows subsequent modification of the package
      set in a consistent way, i.e. all packages in the set will be
      called with the overridden packages. The package sets may be
      hierarchical: the packages in the set are called with the scope
-     provided by `newScope' and the set provides a `newScope' attribute
+     provided by `newScope` and the set provides a `newScope` attribute
      which can form the parent scope for later package sets. */
   makeScope = newScope: f:
     let self = f self // {