Doc: migrate lib.strings to commonmark

1 files changed, 2002 insertions, 564 deletions

diff --git a/lib/strings.nix b/lib/strings.nix
index 49c625e232c0..aafbdffaa7bc 100644
--- a/lib/strings.nix
+++ b/lib/strings.nix
@@ -1,4 +1,6 @@
-/* String manipulation functions. */
+/**
+  String manipulation functions.
+*/
 { lib }:
 let
 
@@ -39,161 +41,371 @@ rec {
     unsafeDiscardStringContext
     ;
 
-  /* Concatenate a list of strings.
+  /**
+    Concatenate a list of strings.
 
-    Type: concatStrings :: [string] -> string
+    # Type
 
-     Example:
-       concatStrings ["foo" "bar"]
-       => "foobar"
+    ```
+    concatStrings :: [string] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatStrings` usage example
+
+    ```nix
+    concatStrings ["foo" "bar"]
+    => "foobar"
+    ```
+
+    :::
   */
   concatStrings = builtins.concatStringsSep "";
 
-  /* Map a function over a list and concatenate the resulting strings.
+  /**
+    Map a function over a list and concatenate the resulting strings.
+
+
+    # Inputs
+
+    `f`
+    : 1\. Function argument
+
+    `list`
+    : 2\. Function argument
+
+    # Type
 
-    Type: concatMapStrings :: (a -> string) -> [a] -> string
+    ```
+    concatMapStrings :: (a -> string) -> [a] -> string
+    ```
 
-     Example:
-       concatMapStrings (x: "a" + x) ["foo" "bar"]
-       => "afooabar"
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatMapStrings` usage example
+
+    ```nix
+    concatMapStrings (x: "a" + x) ["foo" "bar"]
+    => "afooabar"
+    ```
+
+    :::
   */
   concatMapStrings = f: list: concatStrings (map f list);
 
-  /* Like `concatMapStrings` except that the f functions also gets the
-     position as a parameter.
+  /**
+    Like `concatMapStrings` except that the f functions also gets the
+    position as a parameter.
+
+
+    # Inputs
+
+    `f`
+    : 1\. Function argument
+
+    `list`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    concatImapStrings :: (int -> a -> string) -> [a] -> string
+    ```
 
-     Type: concatImapStrings :: (int -> a -> string) -> [a] -> string
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatImapStrings` usage example
 
-     Example:
-       concatImapStrings (pos: x: "${toString pos}-${x}") ["foo" "bar"]
-       => "1-foo2-bar"
+    ```nix
+    concatImapStrings (pos: x: "${toString pos}-${x}") ["foo" "bar"]
+    => "1-foo2-bar"
+    ```
+
+    :::
   */
   concatImapStrings = f: list: concatStrings (lib.imap1 f list);
 
-  /* Place an element between each element of a list
+  /**
+    Place an element between each element of a list
+
+
+    # Inputs
+
+    `separator`
+    : Separator to add between elements
+
+    `list`
+    : Input list
+
+    # Type
+
+    ```
+    intersperse :: a -> [a] -> [a]
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.intersperse` usage example
 
-     Type: intersperse :: a -> [a] -> [a]
+    ```nix
+    intersperse "/" ["usr" "local" "bin"]
+    => ["usr" "/" "local" "/" "bin"].
+    ```
 
-     Example:
-       intersperse "/" ["usr" "local" "bin"]
-       => ["usr" "/" "local" "/" "bin"].
+    :::
   */
   intersperse =
-    # Separator to add between elements
     separator:
-    # Input list
     list:
     if list == [] || length list == 1
     then list
     else tail (lib.concatMap (x: [separator x]) list);
 
-  /* Concatenate a list of strings with a separator between each element
+  /**
+    Concatenate a list of strings with a separator between each element
 
-     Type: concatStringsSep :: string -> [string] -> string
+    # Inputs
 
-     Example:
-        concatStringsSep "/" ["usr" "local" "bin"]
-        => "usr/local/bin"
+    `sep`
+    : Separator to add between elements
+
+    `list`
+    : List of input strings
+
+    # Type
+
+    ```
+    concatStringsSep :: string -> [string] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatStringsSep` usage example
+
+    ```nix
+    concatStringsSep "/" ["usr" "local" "bin"]
+    => "usr/local/bin"
+    ```
+
+    :::
   */
   concatStringsSep = builtins.concatStringsSep;
 
-  /* Maps a function over a list of strings and then concatenates the
-     result with the specified separator interspersed between
-     elements.
+  /**
+    Maps a function over a list of strings and then concatenates the
+    result with the specified separator interspersed between
+    elements.
+
 
-     Type: concatMapStringsSep :: string -> (a -> string) -> [a] -> string
+    # Inputs
 
-     Example:
-        concatMapStringsSep "-" (x: toUpper x)  ["foo" "bar" "baz"]
-        => "FOO-BAR-BAZ"
+    `sep`
+    : Separator to add between elements
+
+    `f`
+    : Function to map over the list
+
+    `list`
+    : List of input strings
+
+    # Type
+
+    ```
+    concatMapStringsSep :: string -> (a -> string) -> [a] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatMapStringsSep` usage example
+
+    ```nix
+    concatMapStringsSep "-" (x: toUpper x)  ["foo" "bar" "baz"]
+    => "FOO-BAR-BAZ"
+    ```
+
+    :::
   */
   concatMapStringsSep =
-    # Separator to add between elements
     sep:
-    # Function to map over the list
     f:
-    # List of input strings
     list: concatStringsSep sep (map f list);
 
-  /* Same as `concatMapStringsSep`, but the mapping function
-     additionally receives the position of its argument.
+  /**
+    Same as `concatMapStringsSep`, but the mapping function
+    additionally receives the position of its argument.
+
+
+    # Inputs
+
+    `sep`
+    : Separator to add between elements
+
+    `f`
+    : Function that receives elements and their positions
+
+    `list`
+    : List of input strings
+
+    # Type
+
+    ```
+    concatIMapStringsSep :: string -> (int -> a -> string) -> [a] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatImapStringsSep` usage example
 
-     Type: concatIMapStringsSep :: string -> (int -> a -> string) -> [a] -> string
+    ```nix
+    concatImapStringsSep "-" (pos: x: toString (x / pos)) [ 6 6 6 ]
+    => "6-3-2"
+    ```
 
-     Example:
-       concatImapStringsSep "-" (pos: x: toString (x / pos)) [ 6 6 6 ]
-       => "6-3-2"
+    :::
   */
   concatImapStringsSep =
-    # Separator to add between elements
     sep:
-    # Function that receives elements and their positions
     f:
-    # List of input strings
     list: concatStringsSep sep (lib.imap1 f list);
 
-  /* Concatenate a list of strings, adding a newline at the end of each one.
-     Defined as `concatMapStrings (s: s + "\n")`.
+  /**
+    Concatenate a list of strings, adding a newline at the end of each one.
+    Defined as `concatMapStrings (s: s + "\n")`.
 
-     Type: concatLines :: [string] -> string
+    # Inputs
 
-     Example:
-       concatLines [ "foo" "bar" ]
-       => "foo\nbar\n"
+    `list`
+    : List of strings. Any element that is not a string will be implicitly converted to a string.
+
+    # Type
+
+    ```
+    concatLines :: [string] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.concatLines` usage example
+
+    ```nix
+    concatLines [ "foo" "bar" ]
+    => "foo\nbar\n"
+    ```
+
+    :::
   */
   concatLines = concatMapStrings (s: s + "\n");
 
-  /*
-    Replicate a string n times,
+  /**
+    Repeat a string `n` times,
     and concatenate the parts into a new string.
 
-    Type: replicate :: int -> string -> string
 
-    Example:
-      replicate 3 "v"
-      => "vvv"
-      replicate 5 "hello"
-      => "hellohellohellohellohello"
+    # Inputs
+
+    `n`
+    : 1\. Function argument
+
+    `s`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    replicate :: int -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.replicate` usage example
+
+    ```nix
+    replicate 3 "v"
+    => "vvv"
+    replicate 5 "hello"
+    => "hellohellohellohellohello"
+    ```
+
+    :::
   */
   replicate = n: s: concatStrings (lib.lists.replicate n s);
 
-  /*
-    Remove leading and trailing whitespace from a string.
+  /**
+    Remove leading and trailing whitespace from a string `s`.
 
     Whitespace is defined as any of the following characters:
       " ", "\t" "\r" "\n"
 
-    Type: trim :: string -> string
+    # Inputs
+
+    `s`
+    : The string to trim
+
+    # Type
+
+    ```
+    trim :: string -> string
+    ```
 
-    Example:
-      trim "   hello, world!   "
-      => "hello, world!"
+    # Examples
+    :::{.example}
+    ## `lib.strings.trim` usage example
+
+    ```nix
+    trim "   hello, world!   "
+    => "hello, world!"
+    ```
+
+    :::
   */
   trim = trimWith {
     start = true;
     end = true;
   };
 
-  /*
-    Remove leading and/or trailing whitespace from a string.
+  /**
+    Remove leading and/or trailing whitespace from a string `s`.
+
     To remove both leading and trailing whitespace, you can also use [`trim`](#function-library-lib.strings.trim)
 
     Whitespace is defined as any of the following characters:
       " ", "\t" "\r" "\n"
 
-    Type: trimWith :: { start ? false, end ? false } -> string -> string
+    # Inputs
+
+    `config` (Attribute set)
+    : `start`
+      : Whether to trim leading whitespace (`false` by default)
+
+    : `end`
+      : Whether to trim trailing whitespace (`false` by default)
+
+    `s`
+    : The string to trim
+
+    # Type
+
+    ```
+    trimWith :: { start :: Bool; end :: Bool } -> String -> String
+    ```
 
-    Example:
-      trimWith { start = true; } "   hello, world!   "}
-      => "hello, world!   "
-      trimWith { end = true; } "   hello, world!   "}
-      => "   hello, world!"
+    # Examples
+    :::{.example}
+    ## `lib.strings.trimWith` usage example
+
+    ```nix
+    trimWith { start = true; } "   hello, world!   "}
+    => "hello, world!   "
+
+    trimWith { end = true; } "   hello, world!   "}
+    => "   hello, world!"
+    ```
+    :::
   */
   trimWith =
     {
-      # Trim leading whitespace (`false` by default)
       start ? false,
-      # Trim trailing whitespace (`false` by default)
       end ? false,
     }:
     s:
@@ -220,83 +432,198 @@ rec {
     in
       optionalString (res != null) (head res);
 
-  /* Construct a Unix-style, colon-separated search path consisting of
-     the given `subDir` appended to each of the given paths.
+  /**
+    Construct a Unix-style, colon-separated search path consisting of
+    the given `subDir` appended to each of the given paths.
+
+    # Inputs
+
+    `subDir`
+    : Directory name to append
+
+    `paths`
+    : List of base paths
+
+    # Type
+
+    ```
+    makeSearchPath :: string -> [string] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.makeSearchPath` usage example
 
-     Type: makeSearchPath :: string -> [string] -> string
+    ```nix
+    makeSearchPath "bin" ["/root" "/usr" "/usr/local"]
+    => "/root/bin:/usr/bin:/usr/local/bin"
+    makeSearchPath "bin" [""]
+    => "/bin"
+    ```
 
-     Example:
-       makeSearchPath "bin" ["/root" "/usr" "/usr/local"]
-       => "/root/bin:/usr/bin:/usr/local/bin"
-       makeSearchPath "bin" [""]
-       => "/bin"
+    :::
   */
   makeSearchPath =
-    # Directory name to append
     subDir:
-    # List of base paths
     paths:
     concatStringsSep ":" (map (path: path + "/" + subDir) (filter (x: x != null) paths));
 
-  /* Construct a Unix-style search path by appending the given
-     `subDir` to the specified `output` of each of the packages. If no
-     output by the given name is found, fallback to `.out` and then to
-     the default.
+  /**
+    Construct a Unix-style search path by appending the given
+    `subDir` to the specified `output` of each of the packages.
 
-     Type: string -> string -> [package] -> string
+    If no output by the given name is found, fallback to `.out` and then to
+    the default.
 
-     Example:
-       makeSearchPathOutput "dev" "bin" [ pkgs.openssl pkgs.zlib ]
-       => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r-dev/bin:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8/bin"
+
+    # Inputs
+
+    `output`
+    : Package output to use
+
+    `subDir`
+    : Directory name to append
+
+    `pkgs`
+    : List of packages
+
+    # Type
+
+    ```
+    makeSearchPathOutput :: string -> string -> [package] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.makeSearchPathOutput` usage example
+
+    ```nix
+    makeSearchPathOutput "dev" "bin" [ pkgs.openssl pkgs.zlib ]
+    => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r-dev/bin:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8/bin"
+    ```
+
+    :::
   */
   makeSearchPathOutput =
-    # Package output to use
     output:
-    # Directory name to append
     subDir:
-    # List of packages
     pkgs: makeSearchPath subDir (map (lib.getOutput output) pkgs);
 
-  /* Construct a library search path (such as RPATH) containing the
-     libraries for a set of packages
+  /**
+    Construct a library search path (such as RPATH) containing the
+    libraries for a set of packages
+
+    # Inputs
+
+    `packages`
+    : List of packages
+
+    # Type
+
+    ```
+    makeLibraryPath :: [package] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.makeLibraryPath` usage example
+
+    ```nix
+    makeLibraryPath [ "/usr" "/usr/local" ]
+    => "/usr/lib:/usr/local/lib"
+    pkgs = import <nixpkgs> { }
+    makeLibraryPath [ pkgs.openssl pkgs.zlib ]
+    => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r/lib:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8/lib"
+    ```
 
-     Example:
-       makeLibraryPath [ "/usr" "/usr/local" ]
-       => "/usr/lib:/usr/local/lib"
-       pkgs = import <nixpkgs> { }
-       makeLibraryPath [ pkgs.openssl pkgs.zlib ]
-       => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r/lib:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8/lib"
+    :::
   */
   makeLibraryPath = makeSearchPathOutput "lib" "lib";
 
-  /* Construct an include search path (such as C_INCLUDE_PATH) containing the
-     header files for a set of packages or paths.
+  /**
+    Construct an include search path (such as C_INCLUDE_PATH) containing the
+    header files for a set of packages or paths.
 
-     Example:
-       makeIncludePath [ "/usr" "/usr/local" ]
-       => "/usr/include:/usr/local/include"
-       pkgs = import <nixpkgs> { }
-       makeIncludePath [ pkgs.openssl pkgs.zlib ]
-       => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r-dev/include:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8-dev/include"
+    # Inputs
+
+    `packages`
+    : List of packages
+
+    # Type
+
+    ```
+    makeIncludePath :: [package] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.makeIncludePath` usage example
+
+    ```nix
+    makeIncludePath [ "/usr" "/usr/local" ]
+    => "/usr/include:/usr/local/include"
+    pkgs = import <nixpkgs> { }
+    makeIncludePath [ pkgs.openssl pkgs.zlib ]
+    => "/nix/store/9rz8gxhzf8sw4kf2j2f1grr49w8zx5vj-openssl-1.0.1r-dev/include:/nix/store/wwh7mhwh269sfjkm6k5665b5kgp7jrk2-zlib-1.2.8-dev/include"
+    ```
+
+    :::
   */
   makeIncludePath = makeSearchPathOutput "dev" "include";
 
-  /* Construct a binary search path (such as $PATH) containing the
-     binaries for a set of packages.
+  /**
+    Construct a binary search path (such as $PATH) containing the
+    binaries for a set of packages.
+
+    # Inputs
+
+    `packages`
+    : List of packages
 
-     Example:
-       makeBinPath ["/root" "/usr" "/usr/local"]
-       => "/root/bin:/usr/bin:/usr/local/bin"
+    # Type
+
+    ```
+    makeBinPath :: [package] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.makeBinPath` usage example
+
+    ```nix
+    makeBinPath ["/root" "/usr" "/usr/local"]
+    => "/root/bin:/usr/bin:/usr/local/bin"
+    ```
+
+    :::
   */
   makeBinPath = makeSearchPathOutput "bin" "bin";
 
-  /* Normalize path, removing extraneous /s
+  /**
+    Normalize path, removing extraneous /s
+
+
+    # Inputs
+
+    `s`
+    : 1\. Function argument
 
-     Type: normalizePath :: string -> string
+    # Type
 
-     Example:
-       normalizePath "/a//b///c/"
-       => "/a/b/c/"
+    ```
+    normalizePath :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.normalizePath` usage example
+
+    ```nix
+    normalizePath "/a//b///c/"
+    => "/a/b/c/"
+    ```
+
+    :::
   */
   normalizePath = s:
     warnIf
@@ -313,37 +640,75 @@ rec {
           (stringToCharacters s)
       );
 
-  /* Depending on the boolean `cond', return either the given string
-     or the empty string. Useful to concatenate against a bigger string.
+  /**
+    Depending on the boolean `cond', return either the given string
+    or the empty string. Useful to concatenate against a bigger string.
+
+
+    # Inputs
+
+    `cond`
+    : Condition
+
+    `string`
+    : String to return if condition is true
+
+    # Type
 
-     Type: optionalString :: bool -> string -> string
+    ```
+    optionalString :: bool -> string -> string
+    ```
 
-     Example:
-       optionalString true "some-string"
-       => "some-string"
-       optionalString false "some-string"
-       => ""
+    # Examples
+    :::{.example}
+    ## `lib.strings.optionalString` usage example
+
+    ```nix
+    optionalString true "some-string"
+    => "some-string"
+    optionalString false "some-string"
+    => ""
+    ```
+
+    :::
   */
   optionalString =
-    # Condition
     cond:
-    # String to return if condition is true
     string: if cond then string else "";
 
-  /* Determine whether a string has given prefix.
+  /**
+    Determine whether a string has given prefix.
+
+
+    # Inputs
+
+    `pref`
+    : Prefix to check for
+
+    `str`
+    : Input string
+
+    # Type
 
-     Type: hasPrefix :: string -> string -> bool
+    ```
+    hasPrefix :: string -> string -> bool
+    ```
 
-     Example:
-       hasPrefix "foo" "foobar"
-       => true
-       hasPrefix "foo" "barfoo"
-       => false
+    # Examples
+    :::{.example}
+    ## `lib.strings.hasPrefix` usage example
+
+    ```nix
+    hasPrefix "foo" "foobar"
+    => true
+    hasPrefix "foo" "barfoo"
+    => false
+    ```
+
+    :::
   */
   hasPrefix =
-    # Prefix to check for
     pref:
-    # Input string
     str:
     # Before 23.05, paths would be copied to the store before converting them
     # to strings and comparing. This was surprising and confusing.
@@ -357,20 +722,39 @@ rec {
             You might want to use `lib.path.hasPrefix` instead, which correctly supports paths.''
       (substring 0 (stringLength pref) str == pref);
 
-  /* Determine whether a string has given suffix.
+  /**
+    Determine whether a string has given suffix.
+
+
+    # Inputs
+
+    `suffix`
+    : Suffix to check for
+
+    `content`
+    : Input string
+
+    # Type
 
-     Type: hasSuffix :: string -> string -> bool
+    ```
+    hasSuffix :: string -> string -> bool
+    ```
 
-     Example:
-       hasSuffix "foo" "foobar"
-       => false
-       hasSuffix "foo" "barfoo"
-       => true
+    # Examples
+    :::{.example}
+    ## `lib.strings.hasSuffix` usage example
+
+    ```nix
+    hasSuffix "foo" "foobar"
+    => false
+    hasSuffix "foo" "barfoo"
+    => true
+    ```
+
+    :::
   */
   hasSuffix =
-    # Suffix to check for
     suffix:
-    # Input string
     content:
     let
       lenContent = stringLength content;
@@ -390,19 +774,40 @@ rec {
         && substring (lenContent - lenSuffix) lenContent content == suffix
       );
 
-  /* Determine whether a string contains the given infix
+  /**
+    Determine whether a string contains the given infix
+
+
+    # Inputs
+
+    `infix`
+    : 1\. Function argument
+
+    `content`
+    : 2\. Function argument
+
+    # Type
 
-    Type: hasInfix :: string -> string -> bool
+    ```
+    hasInfix :: string -> string -> bool
+    ```
 
-    Example:
-      hasInfix "bc" "abcd"
-      => true
-      hasInfix "ab" "abcd"
-      => true
-      hasInfix "cd" "abcd"
-      => true
-      hasInfix "foo" "abcd"
-      => false
+    # Examples
+    :::{.example}
+    ## `lib.strings.hasInfix` usage example
+
+    ```nix
+    hasInfix "bc" "abcd"
+    => true
+    hasInfix "ab" "abcd"
+    => true
+    hasInfix "cd" "abcd"
+    => true
+    hasInfix "foo" "abcd"
+    => false
+    ```
+
+    :::
   */
   hasInfix = infix: content:
     # Before 23.05, paths would be copied to the store before converting them
@@ -416,35 +821,74 @@ rec {
             This behavior is deprecated and will throw an error in the future.''
       (builtins.match ".*${escapeRegex infix}.*" "${content}" != null);
 
-  /* Convert a string to a list of characters (i.e. singleton strings).
-     This allows you to, e.g., map a function over each character.  However,
-     note that this will likely be horribly inefficient; Nix is not a
-     general purpose programming language. Complex string manipulations
-     should, if appropriate, be done in a derivation.
-     Also note that Nix treats strings as a list of bytes and thus doesn't
-     handle unicode.
+  /**
+    Convert a string `s` to a list of characters (i.e. singleton strings).
+    This allows you to, e.g., map a function over each character.  However,
+    note that this will likely be horribly inefficient; Nix is not a
+    general purpose programming language. Complex string manipulations
+    should, if appropriate, be done in a derivation.
+    Also note that Nix treats strings as a list of bytes and thus doesn't
+    handle unicode.
+
+
+    # Inputs
+
+    `s`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    stringToCharacters :: string -> [string]
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.stringToCharacters` usage example
 
-     Type: stringToCharacters :: string -> [string]
+    ```nix
+    stringToCharacters ""
+    => [ ]
+    stringToCharacters "abc"
+    => [ "a" "b" "c" ]
+    stringToCharacters "🦄"
+    => [ "�" "�" "�" "�" ]
+    ```
 
-     Example:
-       stringToCharacters ""
-       => [ ]
-       stringToCharacters "abc"
-       => [ "a" "b" "c" ]
-       stringToCharacters "🦄"
-       => [ "�" "�" "�" "�" ]
+    :::
   */
   stringToCharacters = s:
     genList (p: substring p 1 s) (stringLength s);
 
-  /* Manipulate a string character by character and replace them by
-     strings before concatenating the results.
+  /**
+    Manipulate a string character by character and replace them by
+    strings before concatenating the results.
+
+
+    # Inputs
+
+    `f`
+    : Function to map over each individual character
+
+    `s`
+    : Input string
+
+    # Type
+
+    ```
+    stringAsChars :: (string -> string) -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.stringAsChars` usage example
 
-     Type: stringAsChars :: (string -> string) -> string -> string
+    ```nix
+    stringAsChars (x: if x == "a" then "i" else x) "nax"
+    => "nix"
+    ```
 
-     Example:
-       stringAsChars (x: if x == "a" then "i" else x) "nax"
-       => "nix"
+    :::
   */
   stringAsChars =
     # Function to map over each individual character
@@ -454,51 +898,126 @@ rec {
       map f (stringToCharacters s)
     );
 
-  /* Convert char to ascii value, must be in printable range
+  /**
+    Convert char to ascii value, must be in printable range
 
-     Type: charToInt :: string -> int
 
-     Example:
-       charToInt "A"
-       => 65
-       charToInt "("
-       => 40
+    # Inputs
 
+    `c`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    charToInt :: string -> int
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.charToInt` usage example
+
+    ```nix
+    charToInt "A"
+    => 65
+    charToInt "("
+    => 40
+    ```
+
+    :::
   */
   charToInt = c: builtins.getAttr c asciiTable;
 
-  /* Escape occurrence of the elements of `list` in `string` by
-     prefixing it with a backslash.
+  /**
+    Escape occurrence of the elements of `list` in `string` by
+    prefixing it with a backslash.
+
+
+    # Inputs
+
+    `list`
+    : 1\. Function argument
 
-     Type: escape :: [string] -> string -> string
+    `string`
+    : 2\. Function argument
 
-     Example:
-       escape ["(" ")"] "(foo)"
-       => "\\(foo\\)"
+    # Type
+
+    ```
+    escape :: [string] -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escape` usage example
+
+    ```nix
+    escape ["(" ")"] "(foo)"
+    => "\\(foo\\)"
+    ```
+
+    :::
   */
   escape = list: replaceStrings list (map (c: "\\${c}") list);
 
-  /* Escape occurrence of the element of `list` in `string` by
-     converting to its ASCII value and prefixing it with \\x.
-     Only works for printable ascii characters.
+  /**
+    Escape occurrence of the element of `list` in `string` by
+    converting to its ASCII value and prefixing it with \\x.
+    Only works for printable ascii characters.
+
+
+    # Inputs
+
+    `list`
+    : 1\. Function argument
 
-     Type: escapeC = [string] -> string -> string
+    `string`
+    : 2\. Function argument
 
-     Example:
-       escapeC [" "] "foo bar"
-       => "foo\\x20bar"
+    # Type
 
+    ```
+    escapeC = [string] -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeC` usage example
+
+    ```nix
+    escapeC [" "] "foo bar"
+    => "foo\\x20bar"
+    ```
+
+    :::
   */
   escapeC = list: replaceStrings list (map (c: "\\x${ toLower (lib.toHexString (charToInt c))}") list);
 
-  /* Escape the string so it can be safely placed inside a URL
-     query.
+  /**
+    Escape the `string` so it can be safely placed inside a URL
+    query.
+
+    # Inputs
+
+    `string`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    escapeURL :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeURL` usage example
 
-     Type: escapeURL :: string -> string
+    ```nix
+    escapeURL "foo/bar baz"
+    => "foo%2Fbar%20baz"
+    ```
 
-     Example:
-       escapeURL "foo/bar baz"
-       => "foo%2Fbar%20baz"
+    :::
   */
   escapeURL = let
     unreserved = [ "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" "Q" "R" "S" "T" "U" "V" "W" "X" "Y" "Z" "a" "b" "c" "d" "e" "f" "g" "h" "i" "j" "k" "l" "m" "n" "o" "p" "q" "r" "s" "t" "u" "v" "w" "x" "y" "z" "0" "1" "2" "3" "4" "5" "6" "7" "8" "9" "-" "_" "." "~" ];
@@ -506,55 +1025,129 @@ rec {
   in
     replaceStrings (builtins.attrNames toEscape) (lib.mapAttrsToList (_: c: "%${fixedWidthString 2 "0" (lib.toHexString c)}") toEscape);
 
-  /* Quote string to be used safely within the Bourne shell.
+  /**
+    Quote `string` to be used safely within the Bourne shell.
 
-     Type: escapeShellArg :: string -> string
 
-     Example:
-       escapeShellArg "esc'ape\nme"
-       => "'esc'\\''ape\nme'"
+    # Inputs
+
+    `string`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    escapeShellArg :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeShellArg` usage example
+
+    ```nix
+    escapeShellArg "esc'ape\nme"
+    => "'esc'\\''ape\nme'"
+    ```
+
+    :::
   */
   escapeShellArg = arg: "'${replaceStrings ["'"] ["'\\''"] (toString arg)}'";
 
-  /* Quote all arguments to be safely passed to the Bourne shell.
+  /**
+    Quote all arguments to be safely passed to the Bourne shell.
+
+    # Inputs
 
-     Type: escapeShellArgs :: [string] -> string
+    `args`
+    : 1\. Function argument
 
-     Example:
-       escapeShellArgs ["one" "two three" "four'five"]
-       => "'one' 'two three' 'four'\\''five'"
+    # Type
+
+    ```
+    escapeShellArgs :: [string] -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeShellArgs` usage example
+
+    ```nix
+    escapeShellArgs ["one" "two three" "four'five"]
+    => "'one' 'two three' 'four'\\''five'"
+    ```
+
+    :::
   */
   escapeShellArgs = concatMapStringsSep " " escapeShellArg;
 
-  /* Test whether the given name is a valid POSIX shell variable name.
+  /**
+    Test whether the given `name` is a valid POSIX shell variable name.
+
+
+    # Inputs
+
+    `name`
+    : 1\. Function argument
+
+    # Type
 
-     Type: string -> bool
+    ```
+    string -> bool
+    ```
 
-     Example:
-       isValidPosixName "foo_bar000"
-       => true
-       isValidPosixName "0-bad.jpg"
-       => false
+    # Examples
+    :::{.example}
+    ## `lib.strings.isValidPosixName` usage example
+
+    ```nix
+    isValidPosixName "foo_bar000"
+    => true
+    isValidPosixName "0-bad.jpg"
+    => false
+    ```
+
+    :::
   */
   isValidPosixName = name: match "[a-zA-Z_][a-zA-Z0-9_]*" name != null;
 
-  /* Translate a Nix value into a shell variable declaration, with proper escaping.
+  /**
+    Translate a Nix value into a shell variable declaration, with proper escaping.
+
+    The value can be a string (mapped to a regular variable), a list of strings
+    (mapped to a Bash-style array) or an attribute set of strings (mapped to a
+    Bash-style associative array). Note that "string" includes string-coercible
+    values like paths or derivations.
+
+    Strings are translated into POSIX sh-compatible code; lists and attribute sets
+    assume a shell that understands Bash syntax (e.g. Bash or ZSH).
+
+
+    # Inputs
+
+    `name`
+    : 1\. Function argument
+
+    `value`
+    : 2\. Function argument
 
-     The value can be a string (mapped to a regular variable), a list of strings
-     (mapped to a Bash-style array) or an attribute set of strings (mapped to a
-     Bash-style associative array). Note that "string" includes string-coercible
-     values like paths or derivations.
+    # Type
 
-     Strings are translated into POSIX sh-compatible code; lists and attribute sets
-     assume a shell that understands Bash syntax (e.g. Bash or ZSH).
+    ```
+    string -> ( string | [string] | { ${name} :: string; } ) -> string
+    ```
 
-     Type: string -> (string | listOf string | attrsOf string) -> string
+    # Examples
+    :::{.example}
+    ## `lib.strings.toShellVar` usage example
 
-     Example:
-       ''
-         ${toShellVar "foo" "some string"}
-         [[ "$foo" == "some string" ]]
-       ''
+    ```nix
+    ''
+      ${toShellVar "foo" "some string"}
+      [[ "$foo" == "some string" ]]
+    ''
+    ```
+
+    :::
   */
   toShellVar = name: value:
     lib.throwIfNot (isValidPosixName name) "toShellVar: ${name} is not a valid shell variable name" (
@@ -570,65 +1163,154 @@ rec {
       "${name}=${escapeShellArg value}"
     );
 
-  /* Translate an attribute set into corresponding shell variable declarations
-     using `toShellVar`.
+  /**
+    Translate an attribute set `vars` into corresponding shell variable declarations
+    using `toShellVar`.
+
+
+    # Inputs
+
+    `vars`
+    : 1\. Function argument
 
-     Type: attrsOf (string | listOf string | attrsOf string) -> string
+    # Type
+
+    ```
+    toShellVars :: {
+      ${name} :: string | [ string ] | { ${key} :: string; };
+    } -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.toShellVars` usage example
+
+    ```nix
+    let
+      foo = "value";
+      bar = foo;
+    in ''
+      ${toShellVars { inherit foo bar; }}
+      [[ "$foo" == "$bar" ]]
+    ''
+    ```
 
-     Example:
-       let
-         foo = "value";
-         bar = foo;
-       in ''
-         ${toShellVars { inherit foo bar; }}
-         [[ "$foo" == "$bar" ]]
-       ''
+    :::
   */
   toShellVars = vars: concatStringsSep "\n" (lib.mapAttrsToList toShellVar vars);
 
-  /* Turn a string into a Nix expression representing that string
+  /**
+    Turn a string `s` into a Nix expression representing that string
 
-     Type: string -> string
+    # Inputs
 
-     Example:
-       escapeNixString "hello\${}\n"
-       => "\"hello\\\${}\\n\""
+    `s`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    escapeNixString :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeNixString` usage example
+
+    ```nix
+    escapeNixString "hello\${}\n"
+    => "\"hello\\\${}\\n\""
+    ```
+
+    :::
   */
   escapeNixString = s: escape ["$"] (toJSON s);
 
-  /* Turn a string into an exact regular expression
+  /**
+    Turn a string `s` into an exact regular expression
+
+    # Inputs
+
+    `s`
+    : 1\. Function argument
 
-     Type: string -> string
+    # Type
 
-     Example:
-       escapeRegex "[^a-z]*"
-       => "\\[\\^a-z]\\*"
+    ```
+    escapeRegex :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeRegex` usage example
+
+    ```nix
+    escapeRegex "[^a-z]*"
+    => "\\[\\^a-z]\\*"
+    ```
+
+    :::
   */
   escapeRegex = escape (stringToCharacters "\\[{()^$?*+|.");
 
-  /* Quotes a string if it can't be used as an identifier directly.
+  /**
+    Quotes a string `s` if it can't be used as an identifier directly.
+
+
+    # Inputs
+
+    `s`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    escapeNixIdentifier :: string -> string
+    ```
 
-     Type: string -> string
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeNixIdentifier` usage example
 
-     Example:
-       escapeNixIdentifier "hello"
-       => "hello"
-       escapeNixIdentifier "0abc"
-       => "\"0abc\""
+    ```nix
+    escapeNixIdentifier "hello"
+    => "hello"
+    escapeNixIdentifier "0abc"
+    => "\"0abc\""
+    ```
+
+    :::
   */
   escapeNixIdentifier = s:
     # Regex from https://github.com/NixOS/nix/blob/d048577909e383439c2549e849c5c2f2016c997e/src/libexpr/lexer.l#L91
     if match "[a-zA-Z_][a-zA-Z0-9_'-]*" s != null
     then s else escapeNixString s;
 
-  /* Escapes a string such that it is safe to include verbatim in an XML
-     document.
+  /**
+    Escapes a string `s` such that it is safe to include verbatim in an XML
+    document.
+
+    # Inputs
+
+    `s`
+    : 1\. Function argument
+
+    # Type
 
-     Type: string -> string
+    ```
+    escapeXML :: string -> string
+    ```
 
-     Example:
-       escapeXML ''"test" 'test' < & >''
-       => "&quot;test&quot; &apos;test&apos; &lt; &amp; &gt;"
+    # Examples
+    :::{.example}
+    ## `lib.strings.escapeXML` usage example
+
+    ```nix
+    escapeXML ''"test" 'test' < & >''
+    => "&quot;test&quot; &apos;test&apos; &lt; &amp; &gt;"
+    ```
+
+    :::
   */
   escapeXML = builtins.replaceStrings
     ["\"" "'" "<" ">" "&"]
@@ -641,49 +1323,144 @@ rec {
   lowerChars = stringToCharacters "abcdefghijklmnopqrstuvwxyz";
   upperChars = stringToCharacters "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 
-  /* Converts an ASCII string to lower-case.
+  /**
+    Converts an ASCII string `s` to lower-case.
+
+    # Inputs
 
-     Type: toLower :: string -> string
+    `s`
+    : The string to convert to lower-case.
 
-     Example:
-       toLower "HOME"
-       => "home"
+    # Type
+
+    ```
+    toLower :: string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.toLower` usage example
+
+    ```nix
+    toLower "HOME"
+    => "home"
+    ```
+
+    :::
   */
   toLower = replaceStrings upperChars lowerChars;
 
-  /* Converts an ASCII string to upper-case.
+  /**
+    Converts an ASCII string `s` to upper-case.
+
+    # Inputs
+
+    `s`
+    : The string to convert to upper-case.
+
+
+    # Type
 
-     Type: toUpper :: string -> string
+    ```
+    toUpper :: string -> string
+    ```
 
-     Example:
-       toUpper "home"
-       => "HOME"
+    # Examples
+    :::{.example}
+    ## `lib.strings.toUpper` usage example
+
+    ```nix
+    toUpper "home"
+    => "HOME"
+    ```
+
+    :::
   */
   toUpper = replaceStrings lowerChars upperChars;
 
-  /* Appends string context from another string.  This is an implementation
-     detail of Nix and should be used carefully.
+  /**
+    Appends string context from string like object `src` to `target`.
+
+    :::{.warning}
+    This is an implementation
+    detail of Nix and should be used carefully.
+    :::
+
+    Strings in Nix carry an invisible `context` which is a list of strings
+    representing store paths. If the string is later used in a derivation
+    attribute, the derivation will properly populate the inputDrvs and
+    inputSrcs.
+
+
+    # Inputs
+
+    `src`
+    : The string to take the context from. If the argument is not a string,
+      it will be implicitly converted to a string.
 
-     Strings in Nix carry an invisible `context` which is a list of strings
-     representing store paths.  If the string is later used in a derivation
-     attribute, the derivation will properly populate the inputDrvs and
-     inputSrcs.
+    `target`
+    : The string to append the context to. If the argument is not a string,
+      it will be implicitly converted to a string.
 
-     Example:
-       pkgs = import <nixpkgs> { };
-       addContextFrom pkgs.coreutils "bar"
-       => "bar"
+    # Type
+
+    ```
+    addContextFrom :: string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.addContextFrom` usage example
+
+    ```nix
+    pkgs = import <nixpkgs> { };
+    addContextFrom pkgs.coreutils "bar"
+    => "bar"
+    ```
+
+    The context can be displayed using the `toString` function:
+
+    ```nix
+    nix-repl> builtins.getContext (lib.strings.addContextFrom pkgs.coreutils "bar")
+    {
+      "/nix/store/m1s1d2dk2dqqlw3j90jl3cjy2cykbdxz-coreutils-9.5.drv" = { ... };
+    }
+    ```
+
+    :::
   */
-  addContextFrom = a: b: substring 0 0 a + b;
+  addContextFrom = src: target: substring 0 0 src + target;
+
+  /**
+    Cut a string with a separator and produces a list of strings which
+    were separated by this separator.
 
-  /* Cut a string with a separator and produces a list of strings which
-     were separated by this separator.
+    # Inputs
 
-     Example:
-       splitString "." "foo.bar.baz"
-       => [ "foo" "bar" "baz" ]
-       splitString "/" "/usr/local/bin"
-       => [ "" "usr" "local" "bin" ]
+    `sep`
+    : 1\. Function argument
+
+    `s`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    splitString :: string -> string -> [string]
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.splitString` usage example
+
+    ```nix
+    splitString "." "foo.bar.baz"
+    => [ "foo" "bar" "baz" ]
+    splitString "/" "/usr/local/bin"
+    => [ "" "usr" "local" "bin" ]
+    ```
+
+    :::
   */
   splitString = sep: s:
     let
@@ -691,20 +1468,39 @@ rec {
     in
       map (addContextFrom s) splits;
 
-  /* Return a string without the specified prefix, if the prefix matches.
 
-     Type: string -> string -> string
+  /**
+    Return a string without the specified prefix, if the prefix matches.
+
+    # Inputs
+
+    `prefix`
+    : Prefix to remove if it matches
 
-     Example:
-       removePrefix "foo." "foo.bar.baz"
-       => "bar.baz"
-       removePrefix "xxx" "foo.bar.baz"
-       => "foo.bar.baz"
+    `str`
+    : Input string
+
+    # Type
+
+    ```
+    removePrefix :: string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.removePrefix` usage example
+
+    ```nix
+    removePrefix "foo." "foo.bar.baz"
+    => "bar.baz"
+    removePrefix "xxx" "foo.bar.baz"
+    => "foo.bar.baz"
+    ```
+
+    :::
   */
   removePrefix =
-    # Prefix to remove if it matches
     prefix:
-    # Input string
     str:
     # Before 23.05, paths would be copied to the store before converting them
     # to strings and comparing. This was surprising and confusing.
@@ -724,20 +1520,39 @@ rec {
       else
         str);
 
-  /* Return a string without the specified suffix, if the suffix matches.
+  /**
+    Return a string without the specified suffix, if the suffix matches.
+
+
+    # Inputs
 
-     Type: string -> string -> string
+    `suffix`
+    : Suffix to remove if it matches
 
-     Example:
-       removeSuffix "front" "homefront"
-       => "home"
-       removeSuffix "xxx" "homefront"
-       => "homefront"
+    `str`
+    : Input string
+
+    # Type
+
+    ```
+    removeSuffix :: string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.removeSuffix` usage example
+
+    ```nix
+    removeSuffix "front" "homefront"
+    => "home"
+    removeSuffix "xxx" "homefront"
+    => "homefront"
+    ```
+
+    :::
   */
   removeSuffix =
-    # Suffix to remove if it matches
     suffix:
-    # Input string
     str:
     # Before 23.05, paths would be copied to the store before converting them
     # to strings and comparing. This was surprising and confusing.
@@ -757,37 +1572,103 @@ rec {
       else
         str);
 
-  /* Return true if string v1 denotes a version older than v2.
+  /**
+    Return true if string `v1` denotes a version older than `v2`.
+
 
-     Example:
-       versionOlder "1.1" "1.2"
-       => true
-       versionOlder "1.1" "1.1"
-       => false
+    # Inputs
+
+    `v1`
+    : 1\. Function argument
+
+    `v2`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    versionOlder :: String -> String -> Bool
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.versionOlder` usage example
+
+    ```nix
+    versionOlder "1.1" "1.2"
+    => true
+    versionOlder "1.1" "1.1"
+    => false
+    ```
+
+    :::
   */
   versionOlder = v1: v2: compareVersions v2 v1 == 1;
 
-  /* Return true if string v1 denotes a version equal to or newer than v2.
+  /**
+    Return true if string v1 denotes a version equal to or newer than v2.
+
+
+    # Inputs
+
+    `v1`
+    : 1\. Function argument
+
+    `v2`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    versionAtLeast :: String -> String -> Bool
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.versionAtLeast` usage example
+
+    ```nix
+    versionAtLeast "1.1" "1.0"
+    => true
+    versionAtLeast "1.1" "1.1"
+    => true
+    versionAtLeast "1.1" "1.2"
+    => false
+    ```
 
-     Example:
-       versionAtLeast "1.1" "1.0"
-       => true
-       versionAtLeast "1.1" "1.1"
-       => true
-       versionAtLeast "1.1" "1.2"
-       => false
+    :::
   */
   versionAtLeast = v1: v2: !versionOlder v1 v2;
 
-  /* This function takes an argument that's either a derivation or a
-     derivation's "name" attribute and extracts the name part from that
-     argument.
+  /**
+    This function takes an argument `x` that's either a derivation or a
+    derivation's "name" attribute and extracts the name part from that
+    argument.
 
-     Example:
-       getName "youtube-dl-2016.01.01"
-       => "youtube-dl"
-       getName pkgs.youtube-dl
-       => "youtube-dl"
+    # Inputs
+
+    `x`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    getName :: String | Derivation -> String
+    ```
+
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.getName` usage example
+
+    ```nix
+    getName "youtube-dl-2016.01.01"
+    => "youtube-dl"
+    getName pkgs.youtube-dl
+    => "youtube-dl"
+    ```
+
+    :::
   */
   getName = let
     parse = drv: (parseDrvName drv).name;
@@ -796,15 +1677,35 @@ rec {
     then parse x
     else x.pname or (parse x.name);
 
-  /* This function takes an argument that's either a derivation or a
-     derivation's "name" attribute and extracts the version part from that
-     argument.
+  /**
+    This function takes an argument `x` that's either a derivation or a
+    derivation's "name" attribute and extracts the version part from that
+    argument.
+
 
-     Example:
-       getVersion "youtube-dl-2016.01.01"
-       => "2016.01.01"
-       getVersion pkgs.youtube-dl
-       => "2016.01.01"
+    # Inputs
+
+    `x`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    getVersion :: String | Derivation -> String
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.getVersion` usage example
+
+    ```nix
+    getVersion "youtube-dl-2016.01.01"
+    => "2016.01.01"
+    getVersion pkgs.youtube-dl
+    => "2016.01.01"
+    ```
+
+    :::
   */
   getVersion = let
     parse = drv: (parseDrvName drv).version;
@@ -813,14 +1714,38 @@ rec {
     then parse x
     else x.version or (parse x.name);
 
-  /* Extract name with version from URL. Ask for separator which is
-     supposed to start extension.
+  /**
+    Extract name and version from a URL as shown in the examples.
+
+    Separator `sep` is used to determine the end of the extension.
 
-     Example:
-       nameFromURL "https://nixos.org/releases/nix/nix-1.7/nix-1.7-x86_64-linux.tar.bz2" "-"
-       => "nix"
-       nameFromURL "https://nixos.org/releases/nix/nix-1.7/nix-1.7-x86_64-linux.tar.bz2" "_"
-       => "nix-1.7-x86"
+
+    # Inputs
+
+    `url`
+    : 1\. Function argument
+
+    `sep`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    nameFromURL :: String -> String
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.nameFromURL` usage example
+
+    ```nix
+    nameFromURL "https://nixos.org/releases/nix/nix-1.7/nix-1.7-x86_64-linux.tar.bz2" "-"
+    => "nix"
+    nameFromURL "https://nixos.org/releases/nix/nix-1.7/nix-1.7-x86_64-linux.tar.bz2" "_"
+    => "nix-1.7-x86"
+    ```
+
+    :::
   */
   nameFromURL = url: sep:
     let
@@ -829,21 +1754,40 @@ rec {
       name = head (splitString sep filename);
     in assert name != filename; name;
 
-  /* Create a "-D<feature>:<type>=<value>" string that can be passed to typical
-     CMake invocations.
+  /**
+    Create a `"-D<feature>:<type>=<value>"` string that can be passed to typical
+    CMake invocations.
 
-    Type: cmakeOptionType :: string -> string -> string -> string
+    # Inputs
 
-     @param feature The feature to be set
-     @param type The type of the feature to be set, as described in
-                 https://cmake.org/cmake/help/latest/command/set.html
-                 the possible values (case insensitive) are:
-                 BOOL FILEPATH PATH STRING INTERNAL
-     @param value The desired value
+    `feature`
+    : The feature to be set
 
-     Example:
-       cmakeOptionType "string" "ENGINE" "sdl2"
-       => "-DENGINE:STRING=sdl2"
+    `type`
+    : The type of the feature to be set, as described in
+      https://cmake.org/cmake/help/latest/command/set.html
+      the possible values (case insensitive) are:
+      BOOL FILEPATH PATH STRING INTERNAL
+
+    `value`
+    : The desired value
+
+    # Type
+
+    ```
+    cmakeOptionType :: string -> string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.cmakeOptionType` usage example
+
+    ```nix
+    cmakeOptionType "string" "ENGINE" "sdl2"
+    => "-DENGINE:STRING=sdl2"
+    ```
+
+    :::
   */
   cmakeOptionType = let
     types = [ "BOOL" "FILEPATH" "PATH" "STRING" "INTERNAL" ];
@@ -853,158 +1797,373 @@ rec {
     assert (isString value);
     "-D${feature}:${toUpper type}=${value}";
 
-  /* Create a -D<condition>={TRUE,FALSE} string that can be passed to typical
-     CMake invocations.
+  /**
+    Create a -D<condition>={TRUE,FALSE} string that can be passed to typical
+    CMake invocations.
+
+
+    # Inputs
 
-    Type: cmakeBool :: string -> bool -> string
+    `condition`
+    : The condition to be made true or false
 
-     @param condition The condition to be made true or false
-     @param flag The controlling flag of the condition
+    `flag`
+    : The controlling flag of the condition
 
-     Example:
-       cmakeBool "ENABLE_STATIC_LIBS" false
-       => "-DENABLESTATIC_LIBS:BOOL=FALSE"
+    # Type
+
+    ```
+    cmakeBool :: string -> bool -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.cmakeBool` usage example
+
+    ```nix
+    cmakeBool "ENABLE_STATIC_LIBS" false
+    => "-DENABLESTATIC_LIBS:BOOL=FALSE"
+    ```
+
+    :::
   */
   cmakeBool = condition: flag:
     assert (lib.isString condition);
     assert (lib.isBool flag);
     cmakeOptionType "bool" condition (lib.toUpper (lib.boolToString flag));
 
-  /* Create a -D<feature>:STRING=<value> string that can be passed to typical
-     CMake invocations.
-     This is the most typical usage, so it deserves a special case.
+  /**
+    Create a -D<feature>:STRING=<value> string that can be passed to typical
+    CMake invocations.
+    This is the most typical usage, so it deserves a special case.
+
+
+    # Inputs
+
+    `feature`
+    : The feature to be set
+
+    `value`
+    : The desired value
 
-    Type: cmakeFeature :: string -> string -> string
 
-     @param condition The condition to be made true or false
-     @param flag The controlling flag of the condition
+    # Type
 
-     Example:
-       cmakeFeature "MODULES" "badblock"
-       => "-DMODULES:STRING=badblock"
+    ```
+    cmakeFeature :: string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.cmakeFeature` usage example
+
+    ```nix
+    cmakeFeature "MODULES" "badblock"
+    => "-DMODULES:STRING=badblock"
+    ```
+
+    :::
   */
   cmakeFeature = feature: value:
     assert (lib.isString feature);
     assert (lib.isString value);
     cmakeOptionType "string" feature value;
 
-  /* Create a -D<feature>=<value> string that can be passed to typical Meson
-     invocations.
+  /**
+    Create a -D<feature>=<value> string that can be passed to typical Meson
+    invocations.
+
+
+    # Inputs
+
+    `feature`
+    : The feature to be set
+
+    `value`
+    : The desired value
 
-    Type: mesonOption :: string -> string -> string
+    # Type
 
-     @param feature The feature to be set
-     @param value The desired value
+    ```
+    mesonOption :: string -> string -> string
+    ```
 
-     Example:
-       mesonOption "engine" "opengl"
-       => "-Dengine=opengl"
+    # Examples
+    :::{.example}
+    ## `lib.strings.mesonOption` usage example
+
+    ```nix
+    mesonOption "engine" "opengl"
+    => "-Dengine=opengl"
+    ```
+
+    :::
   */
   mesonOption = feature: value:
     assert (lib.isString feature);
     assert (lib.isString value);
     "-D${feature}=${value}";
 
-  /* Create a -D<condition>={true,false} string that can be passed to typical
-     Meson invocations.
+  /**
+    Create a -D<condition>={true,false} string that can be passed to typical
+    Meson invocations.
+
+
+    # Inputs
+
+    `condition`
+    : The condition to be made true or false
+
+    `flag`
+    : The controlling flag of the condition
+
+    # Type
+
+    ```
+    mesonBool :: string -> bool -> string
+    ```
 
-    Type: mesonBool :: string -> bool -> string
+    # Examples
+    :::{.example}
+    ## `lib.strings.mesonBool` usage example
 
-     @param condition The condition to be made true or false
-     @param flag The controlling flag of the condition
+    ```nix
+    mesonBool "hardened" true
+    => "-Dhardened=true"
+    mesonBool "static" false
+    => "-Dstatic=false"
+    ```
 
-     Example:
-       mesonBool "hardened" true
-       => "-Dhardened=true"
-       mesonBool "static" false
-       => "-Dstatic=false"
+    :::
   */
   mesonBool = condition: flag:
     assert (lib.isString condition);
     assert (lib.isBool flag);
     mesonOption condition (lib.boolToString flag);
 
-  /* Create a -D<feature>={enabled,disabled} string that can be passed to
-     typical Meson invocations.
+  /**
+    Create a -D<feature>={enabled,disabled} string that can be passed to
+    typical Meson invocations.
 
-    Type: mesonEnable :: string -> bool -> string
 
-     @param feature The feature to be enabled or disabled
-     @param flag The controlling flag
+    # Inputs
 
-     Example:
-       mesonEnable "docs" true
-       => "-Ddocs=enabled"
-       mesonEnable "savage" false
-       => "-Dsavage=disabled"
+    `feature`
+    : The feature to be enabled or disabled
+
+    `flag`
+    : The controlling flag
+
+    # Type
+
+    ```
+    mesonEnable :: string -> bool -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.mesonEnable` usage example
+
+    ```nix
+    mesonEnable "docs" true
+    => "-Ddocs=enabled"
+    mesonEnable "savage" false
+    => "-Dsavage=disabled"
+    ```
+
+    :::
   */
   mesonEnable = feature: flag:
     assert (lib.isString feature);
     assert (lib.isBool flag);
     mesonOption feature (if flag then "enabled" else "disabled");
 
-  /* Create an --{enable,disable}-<feature> string that can be passed to
-     standard GNU Autoconf scripts.
+  /**
+    Create an --{enable,disable}-<feature> string that can be passed to
+    standard GNU Autoconf scripts.
+
 
-     Example:
-       enableFeature true "shared"
-       => "--enable-shared"
-       enableFeature false "shared"
-       => "--disable-shared"
+    # Inputs
+
+    `flag`
+    : 1\. Function argument
+
+    `feature`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    enableFeature :: bool -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.enableFeature` usage example
+
+    ```nix
+    enableFeature true "shared"
+    => "--enable-shared"
+    enableFeature false "shared"
+    => "--disable-shared"
+    ```
+
+    :::
   */
   enableFeature = flag: feature:
     assert lib.isBool flag;
     assert lib.isString feature; # e.g. passing openssl instead of "openssl"
     "--${if flag then "enable" else "disable"}-${feature}";
 
-  /* Create an --{enable-<feature>=<value>,disable-<feature>} string that can be passed to
-     standard GNU Autoconf scripts.
+  /**
+    Create an --{enable-<feature>=<value>,disable-<feature>} string that can be passed to
+    standard GNU Autoconf scripts.
+
+
+    # Inputs
+
+    `flag`
+    : 1\. Function argument
+
+    `feature`
+    : 2\. Function argument
+
+    `value`
+    : 3\. Function argument
+
+    # Type
+
+    ```
+    enableFeatureAs :: bool -> string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.enableFeatureAs` usage example
 
-     Example:
-       enableFeatureAs true "shared" "foo"
-       => "--enable-shared=foo"
-       enableFeatureAs false "shared" (throw "ignored")
-       => "--disable-shared"
+    ```nix
+    enableFeatureAs true "shared" "foo"
+    => "--enable-shared=foo"
+    enableFeatureAs false "shared" (throw "ignored")
+    => "--disable-shared"
+    ```
+
+    :::
   */
   enableFeatureAs = flag: feature: value:
     enableFeature flag feature + optionalString flag "=${value}";
 
-  /* Create an --{with,without}-<feature> string that can be passed to
-     standard GNU Autoconf scripts.
+  /**
+    Create an --{with,without}-<feature> string that can be passed to
+    standard GNU Autoconf scripts.
+
+
+    # Inputs
+
+    `flag`
+    : 1\. Function argument
+
+    `feature`
+    : 2\. Function argument
+
+
+    # Type
+
+    ```
+    withFeature :: bool -> string -> string
+    ```
 
-     Example:
-       withFeature true "shared"
-       => "--with-shared"
-       withFeature false "shared"
-       => "--without-shared"
+    # Examples
+    :::{.example}
+    ## `lib.strings.withFeature` usage example
+
+    ```nix
+    withFeature true "shared"
+    => "--with-shared"
+    withFeature false "shared"
+    => "--without-shared"
+    ```
+
+    :::
   */
   withFeature = flag: feature:
     assert isString feature; # e.g. passing openssl instead of "openssl"
     "--${if flag then "with" else "without"}-${feature}";
 
-  /* Create an --{with-<feature>=<value>,without-<feature>} string that can be passed to
-     standard GNU Autoconf scripts.
+  /**
+    Create an --{with-<feature>=<value>,without-<feature>} string that can be passed to
+    standard GNU Autoconf scripts.
+
+
+    # Inputs
+
+    `flag`
+    : 1\. Function argument
+
+    `feature`
+    : 2\. Function argument
+
+    `value`
+    : 3\. Function argument
+
+    # Type
 
-     Example:
-       withFeatureAs true "shared" "foo"
-       => "--with-shared=foo"
-       withFeatureAs false "shared" (throw "ignored")
-       => "--without-shared"
+    ```
+    withFeatureAs :: bool -> string -> string -> string
+    ```
+
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.withFeatureAs` usage example
+
+    ```nix
+    withFeatureAs true "shared" "foo"
+    => "--with-shared=foo"
+    withFeatureAs false "shared" (throw "ignored")
+    => "--without-shared"
+    ```
+
+    :::
   */
   withFeatureAs = flag: feature: value:
     withFeature flag feature + optionalString flag "=${value}";
 
-  /* Create a fixed width string with additional prefix to match
-     required width.
+  /**
+    Create a fixed width string with additional prefix to match
+    required width.
+
+    This function will fail if the input string is longer than the
+    requested length.
+
+
+    # Inputs
+
+    `width`
+    : 1\. Function argument
 
-     This function will fail if the input string is longer than the
-     requested length.
+    `filler`
+    : 2\. Function argument
 
-     Type: fixedWidthString :: int -> string -> string -> string
+    `str`
+    : 3\. Function argument
 
-     Example:
-       fixedWidthString 5 "0" (toString 15)
-       => "00015"
+    # Type
+
+    ```
+    fixedWidthString :: int -> string -> string -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.fixedWidthString` usage example
+
+    ```nix
+    fixedWidthString 5 "0" (toString 15)
+    => "00015"
+    ```
+
+    :::
   */
   fixedWidthString = width: filler: str:
     let
@@ -1017,23 +2176,67 @@ rec {
             toString strw})";
       if strw == width then str else filler + fixedWidthString reqWidth filler str;
 
-  /* Format a number adding leading zeroes up to fixed width.
+  /**
+    Format a number adding leading zeroes up to fixed width.
+
+
+    # Inputs
+
+    `width`
+    : 1\. Function argument
 
-     Example:
-       fixedWidthNumber 5 15
-       => "00015"
+    `n`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    fixedWidthNumber :: int -> int -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.fixedWidthNumber` usage example
+
+    ```nix
+    fixedWidthNumber 5 15
+    => "00015"
+    ```
+
+    :::
   */
   fixedWidthNumber = width: n: fixedWidthString width "0" (toString n);
 
-  /* Convert a float to a string, but emit a warning when precision is lost
-     during the conversion
+  /**
+    Convert a float to a string, but emit a warning when precision is lost
+    during the conversion
+
+
+    # Inputs
+
+    `float`
+    : 1\. Function argument
 
-     Example:
-       floatToString 0.000001
-       => "0.000001"
-       floatToString 0.0000001
-       => trace: warning: Imprecise conversion from float to string 0.000000
-          "0.000000"
+
+    # Type
+
+    ```
+    floatToString :: float -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.floatToString` usage example
+
+    ```nix
+    floatToString 0.000001
+    => "0.000001"
+    floatToString 0.0000001
+    => trace: warning: Imprecise conversion from float to string 0.000000
+       "0.000000"
+    ```
+
+    :::
   */
   floatToString = float: let
     result = toString float;
@@ -1041,16 +2244,45 @@ rec {
   in lib.warnIf (!precise) "Imprecise conversion from float to string ${result}"
     result;
 
-  /* Soft-deprecated function. While the original implementation is available as
-     isConvertibleWithToString, consider using isStringLike instead, if suitable. */
+  /**
+    Check whether a value `val` can be coerced to a string.
+
+    :::{.warning}
+    Soft-deprecated function. While the original implementation is available as
+    `isConvertibleWithToString`, consider using `isStringLike` instead, if suitable.
+    :::
+
+    # Inputs
+
+    `val`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    isCoercibleToString :: a -> bool
+    ```
+  */
   isCoercibleToString = lib.warnIf (lib.isInOldestRelease 2305)
     "lib.strings.isCoercibleToString is deprecated in favor of either isStringLike or isConvertibleWithToString. Only use the latter if it needs to return true for null, numbers, booleans and list of similarly coercibles."
     isConvertibleWithToString;
 
-  /* Check whether a list or other value can be passed to toString.
+  /**
+    Check whether a list or other value `x` can be passed to toString.
+
+    Many types of value are coercible to string this way, including `int`, `float`,
+    `null`, `bool`, `list` of similarly coercible values.
+
+    # Inputs
+
+    `val`
+    : 1\. Function argument
+
+    # Type
 
-     Many types of value are coercible to string this way, including int, float,
-     null, bool, list of similarly coercible values.
+    ```
+    isConvertibleWithToString :: a -> bool
+    ```
   */
   isConvertibleWithToString = let
     types = [ "null" "int" "float" "bool" ];
@@ -1059,29 +2291,62 @@ rec {
     elem (typeOf x) types ||
     (isList x && lib.all isConvertibleWithToString x);
 
-  /* Check whether a value can be coerced to a string.
-     The value must be a string, path, or attribute set.
+  /**
+    Check whether a value can be coerced to a string.
+    The value must be a string, path, or attribute set.
 
-     String-like values can be used without explicit conversion in
-     string interpolations and in most functions that expect a string.
-   */
+    String-like values can be used without explicit conversion in
+    string interpolations and in most functions that expect a string.
+
+
+    # Inputs
+
+    `x`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    isStringLike :: a -> bool
+    ```
+  */
   isStringLike = x:
     isString x ||
     isPath x ||
     x ? outPath ||
     x ? __toString;
 
-  /* Check whether a value is a store path.
+  /**
+    Check whether a value `x` is a store path.
+
 
-     Example:
-       isStorePath "/nix/store/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11/bin/python"
-       => false
-       isStorePath "/nix/store/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11"
-       => true
-       isStorePath pkgs.python
-       => true
-       isStorePath [] || isStorePath 42 || isStorePath {} || …
-       => false
+    # Inputs
+
+    `x`
+    : 1\. Function argument
+
+    # Type
+
+    ```
+    isStorePath :: a -> bool
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.isStorePath` usage example
+
+    ```nix
+    isStorePath "/nix/store/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11/bin/python"
+    => false
+    isStorePath "/nix/store/d945ibfx9x185xf04b890y4f9g3cbb63-python-2.7.11"
+    => true
+    isStorePath pkgs.python
+    => true
+    isStorePath [] || isStorePath 42 || isStorePath {} || …
+    => false
+    ```
+
+    :::
   */
   isStorePath = x:
     if isStringLike x then
@@ -1091,27 +2356,43 @@ rec {
     else
       false;
 
-  /* Parse a string as an int. Does not support parsing of integers with preceding zero due to
-  ambiguity between zero-padded and octal numbers. See toIntBase10.
+  /**
+    Parse a string as an int. Does not support parsing of integers with preceding zero due to
+    ambiguity between zero-padded and octal numbers. See toIntBase10.
+
+    # Inputs
+
+    `str`
+    : A string to be interpreted as an int.
 
-     Type: string -> int
+    # Type
 
-     Example:
+    ```
+    toInt :: string -> int
+    ```
 
-       toInt "1337"
-       => 1337
+    # Examples
+    :::{.example}
+    ## `lib.strings.toInt` usage example
 
-       toInt "-4"
-       => -4
+    ```nix
+    toInt "1337"
+    => 1337
 
-       toInt " 123 "
-       => 123
+    toInt "-4"
+    => -4
 
-       toInt "00024"
-       => error: Ambiguity in interpretation of 00024 between octal and zero padded integer.
+    toInt " 123 "
+    => 123
 
-       toInt "3.14"
-       => error: floating point JSON numbers are not supported
+    toInt "00024"
+    => error: Ambiguity in interpretation of 00024 between octal and zero padded integer.
+
+    toInt "3.14"
+    => error: floating point JSON numbers are not supported
+    ```
+
+    :::
   */
   toInt =
     let
@@ -1146,25 +2427,42 @@ rec {
       else parsedInput;
 
 
-  /* Parse a string as a base 10 int. This supports parsing of zero-padded integers.
+  /**
+    Parse a string as a base 10 int. This supports parsing of zero-padded integers.
+
+    # Inputs
+
+    `str`
+    : A string to be interpreted as an int.
 
-     Type: string -> int
+    # Type
 
-     Example:
-       toIntBase10 "1337"
-       => 1337
+    ```
+    toIntBase10 :: string -> int
+    ```
 
-       toIntBase10 "-4"
-       => -4
+    # Examples
+    :::{.example}
+    ## `lib.strings.toIntBase10` usage example
 
-       toIntBase10 " 123 "
-       => 123
+    ```nix
+    toIntBase10 "1337"
+    => 1337
 
-       toIntBase10 "00024"
-       => 24
+    toIntBase10 "-4"
+    => -4
 
-       toIntBase10 "3.14"
-       => error: floating point JSON numbers are not supported
+    toIntBase10 " 123 "
+    => 123
+
+    toIntBase10 "00024"
+    => 24
+
+    toIntBase10 "3.14"
+    => error: floating point JSON numbers are not supported
+    ```
+
+    :::
   */
   toIntBase10 =
     let
@@ -1199,20 +2497,48 @@ rec {
       # Return result.
       else parsedInput;
 
-  /* Read a list of paths from `file`, relative to the `rootPath`.
-     Lines beginning with `#` are treated as comments and ignored.
-     Whitespace is significant.
+  /**
+    Read a list of paths from `file`, relative to the `rootPath`.
+    Lines beginning with `#` are treated as comments and ignored.
+    Whitespace is significant.
+
+    :::{.warning}
+    This function is deprecated and should be avoided.
+    :::
 
-     NOTE: This function is not performant and should be avoided.
+    :::{.note}
+    This function is not performant and should be avoided.
+    :::
 
-     Example:
-       readPathsFromFile /prefix
-         ./pkgs/development/libraries/qt-5/5.4/qtbase/series
-       => [ "/prefix/dlopen-resolv.patch" "/prefix/tzdir.patch"
-            "/prefix/dlopen-libXcursor.patch" "/prefix/dlopen-openssl.patch"
-            "/prefix/dlopen-dbus.patch" "/prefix/xdg-config-dirs.patch"
-            "/prefix/nix-profiles-library-paths.patch"
-            "/prefix/compose-search-path.patch" ]
+    # Inputs
+
+    `rootPath`
+    : 1\. Function argument
+
+    `file`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    readPathsFromFile :: string -> string -> [string]
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.readPathsFromFile` usage example
+
+    ```nix
+    readPathsFromFile /prefix
+      ./pkgs/development/libraries/qt-5/5.4/qtbase/series
+    => [ "/prefix/dlopen-resolv.patch" "/prefix/tzdir.patch"
+         "/prefix/dlopen-libXcursor.patch" "/prefix/dlopen-openssl.patch"
+         "/prefix/dlopen-dbus.patch" "/prefix/xdg-config-dirs.patch"
+         "/prefix/nix-profiles-library-paths.patch"
+         "/prefix/compose-search-path.patch" ]
+    ```
+
+    :::
   */
   readPathsFromFile = lib.warn "lib.readPathsFromFile is deprecated, use a list instead."
     (rootPath: file:
@@ -1224,30 +2550,65 @@ rec {
       in
         absolutePaths);
 
-  /* Read the contents of a file removing the trailing \n
+  /**
+    Read the contents of a file removing the trailing \n
+
 
-     Type: fileContents :: path -> string
+    # Inputs
 
-     Example:
-       $ echo "1.0" > ./version
+    `file`
+    : 1\. Function argument
 
-       fileContents ./version
-       => "1.0"
+    # Type
+
+    ```
+    fileContents :: path -> string
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.fileContents` usage example
+
+    ```nix
+    $ echo "1.0" > ./version
+
+    fileContents ./version
+    => "1.0"
+    ```
+
+    :::
   */
   fileContents = file: removeSuffix "\n" (readFile file);
 
 
-  /* Creates a valid derivation name from a potentially invalid one.
+  /**
+    Creates a valid derivation name from a potentially invalid one.
+
+    # Inputs
+
+    `string`
+    : 1\. Function argument
 
-     Type: sanitizeDerivationName :: String -> String
+    # Type
 
-     Example:
-       sanitizeDerivationName "../hello.bar # foo"
-       => "-hello.bar-foo"
-       sanitizeDerivationName ""
-       => "unknown"
-       sanitizeDerivationName pkgs.hello
-       => "-nix-store-2g75chlbpxlrqn15zlby2dfh8hr9qwbk-hello-2.10"
+    ```
+    sanitizeDerivationName :: String -> String
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.sanitizeDerivationName` usage example
+
+    ```nix
+    sanitizeDerivationName "../hello.bar # foo"
+    => "-hello.bar-foo"
+    sanitizeDerivationName ""
+    => "unknown"
+    sanitizeDerivationName pkgs.hello
+    => "-nix-store-2g75chlbpxlrqn15zlby2dfh8hr9qwbk-hello-2.10"
+    ```
+
+    :::
   */
   sanitizeDerivationName =
   let okRegex = match "[[:alnum:]+_?=-][[:alnum:]+._?=-]*";
@@ -1274,19 +2635,41 @@ rec {
     (x: if stringLength x == 0 then "unknown" else x)
   ];
 
-  /* Computes the Levenshtein distance between two strings.
-     Complexity O(n*m) where n and m are the lengths of the strings.
-     Algorithm adjusted from https://stackoverflow.com/a/9750974/6605742
+  /**
+    Computes the Levenshtein distance between two strings `a` and `b`.
+
+    Complexity O(n*m) where n and m are the lengths of the strings.
+    Algorithm adjusted from https://stackoverflow.com/a/9750974/6605742
+
+
+    # Inputs
+
+    `a`
+    : 1\. Function argument
+
+    `b`
+    : 2\. Function argument
 
-     Type: levenshtein :: string -> string -> int
+    # Type
 
-     Example:
-       levenshtein "foo" "foo"
-       => 0
-       levenshtein "book" "hook"
-       => 1
-       levenshtein "hello" "Heyo"
-       => 3
+    ```
+    levenshtein :: string -> string -> int
+    ```
+
+    # Examples
+    :::{.example}
+    ## `lib.strings.levenshtein` usage example
+
+    ```nix
+    levenshtein "foo" "foo"
+    => 0
+    levenshtein "book" "hook"
+    => 1
+    levenshtein "hello" "Heyo"
+    => 3
+    ```
+
+    :::
   */
   levenshtein = a: b: let
     # Two dimensional array with dimensions (stringLength a + 1, stringLength b + 1)
@@ -1307,7 +2690,23 @@ rec {
         ( d (i - 1) (j - 1) + c );
   in d (stringLength a) (stringLength b);
 
-  /* Returns the length of the prefix common to both strings.
+  /**
+    Returns the length of the prefix that appears in both strings `a` and `b`.
+
+
+    # Inputs
+
+    `a`
+    : 1\. Function argument
+
+    `b`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    commonPrefixLength :: string -> string -> int
+    ```
   */
   commonPrefixLength = a: b:
     let
@@ -1315,7 +2714,23 @@ rec {
       go = i: if i >= m then m else if substring i 1 a == substring i 1 b then go (i + 1) else i;
     in go 0;
 
-  /* Returns the length of the suffix common to both strings.
+  /**
+    Returns the length of the suffix common to both strings `a` and `b`.
+
+
+    # Inputs
+
+    `a`
+    : 1\. Function argument
+
+    `b`
+    : 2\. Function argument
+
+    # Type
+
+    ```
+    commonSuffixLength :: string -> string -> int
+    ```
   */
   commonSuffixLength = a: b:
     let
@@ -1323,23 +2738,46 @@ rec {
       go = i: if i >= m then m else if substring (stringLength a - i - 1) 1 a == substring (stringLength b - i - 1) 1 b then go (i + 1) else i;
     in go 0;
 
-  /* Returns whether the levenshtein distance between two strings is at most some value
-     Complexity is O(min(n,m)) for k <= 2 and O(n*m) otherwise
+  /**
+    Returns whether the levenshtein distance between two strings `a` and `b` is at most some value `k`.
+
+    Complexity is O(min(n,m)) for k <= 2 and O(n*m) otherwise
+
+    # Inputs
+
+    `k`
+    : Distance threshold
+
+    `a`
+    : String `a`
+
+    `b`
+    : String `b`
+
+    # Type
+
+    ```
+    levenshteinAtMost :: int -> string -> string -> bool
+    ```
 
-     Type: levenshteinAtMost :: int -> string -> string -> bool
+    # Examples
+    :::{.example}
+    ## `lib.strings.levenshteinAtMost` usage example
 
-     Example:
-       levenshteinAtMost 0 "foo" "foo"
-       => true
-       levenshteinAtMost 1 "foo" "boa"
-       => false
-       levenshteinAtMost 2 "foo" "boa"
-       => true
-       levenshteinAtMost 2 "This is a sentence" "this is a sentense."
-       => false
-       levenshteinAtMost 3 "This is a sentence" "this is a sentense."
-       => true
+    ```nix
+    levenshteinAtMost 0 "foo" "foo"
+    => true
+    levenshteinAtMost 1 "foo" "boa"
+    => false
+    levenshteinAtMost 2 "foo" "boa"
+    => true
+    levenshteinAtMost 2 "This is a sentence" "this is a sentense."
+    => false
+    levenshteinAtMost 3 "This is a sentence" "this is a sentense."
+    => true
+    ```
 
+    :::
   */
   levenshteinAtMost = let
     infixDifferAtMost1 = x: y: stringLength x <= 1 && stringLength y <= 1;