Merge pull request #268619 from tweag/lib-descriptions

lib: Take advantage of section descriptions

+1 -1
lib/attrsets.nix
···
+
/* Operations on attribute sets. */
{ lib }:
-
# Operations on attribute sets.
let
inherit (builtins) head tail length;
+4 -2
lib/filesystem.nix
···
-
# Functions for querying information about the filesystem
-
# without copying any files to the Nix store.
+
/*
+
Functions for querying information about the filesystem
+
without copying any files to the Nix store.
+
*/
{ lib }:
# Tested in lib/tests/filesystem.sh
+10 -9
lib/gvariant.nix
···
+
/*
+
A partial and basic implementation of GVariant formatted strings.
+
See [GVariant Format Strings](https://docs.gtk.org/glib/gvariant-format-strings.html) for details.
+
+
:::{.warning}
+
This API is not considered fully stable and it might therefore
+
change in backwards incompatible ways without prior notice.
+
:::
+
*/
+
# This file is based on https://github.com/nix-community/home-manager
# Copyright (c) 2017-2022 Home Manager contributors
-
#
-
-
{ lib }:
-
/* A partial and basic implementation of GVariant formatted strings.
-
See https://docs.gtk.org/glib/gvariant-format-strings.html for detauls.
-
-
Note, this API is not considered fully stable and it might therefore
-
change in backwards incompatible ways without prior notice.
-
*/
let
inherit (lib)
concatMapStringsSep concatStrings escape head replaceStrings;
+1 -2
lib/lists.nix
···
-
# General list operations.
-
+
/* General list operations. */
{ lib }:
let
inherit (lib.strings) toInt;
+1 -1
lib/options.nix
···
-
# Nixpkgs/NixOS option handling.
+
/* Nixpkgs/NixOS option handling. */
{ lib }:
let
+2 -1
lib/path/default.nix
···
-
# Functions for working with paths, see ./path.md
+
/* Functions for working with path values. */
+
# See ./README.md for internal docs
{ lib }:
let
+1 -1
lib/sources.nix
···
-
# Functions for copying sources to the Nix store.
+
/* Functions for copying sources to the Nix store. */
{ lib }:
# Tested in lib/tests/sources.sh