summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Wilson <gpg@probablyfine.co.uk>2023-08-12 12:04:27 +0100
committerNico Williams <nico@cryptonector.com>2023-08-12 20:46:36 -0500
commitf31c180e8f38c085c4366a91f9bfffc2dd7c2bc2 (patch)
tree25f4c65810c0abf284ae7e26b92df29820d2a576
parent65ed95c93aeaeea96796eb6af5dfe8870eda0992 (diff)
Update documentation to reflect new `defs` field on `modulemeta`
-rw-r--r--docs/content/manual/manual.yml3
-rw-r--r--jq.1.prebuilt2
2 files changed, 3 insertions, 2 deletions
diff --git a/docs/content/manual/manual.yml b/docs/content/manual/manual.yml
index 3a5c5466..6382d835 100644
--- a/docs/content/manual/manual.yml
+++ b/docs/content/manual/manual.yml
@@ -3633,7 +3633,8 @@ sections:
Takes a module name as input and outputs the module's metadata
as an object, with the module's imports (including metadata)
- as an array value for the `deps` key.
+ as an array value for the `deps` key and the module's defined
+ functions as an array value for the `defs` key.
Programs can use this to query a module's metadata, which they
could then use to, for example, search for, download, and
diff --git a/jq.1.prebuilt b/jq.1.prebuilt
index de96f561..f386b49c 100644
--- a/jq.1.prebuilt
+++ b/jq.1.prebuilt
@@ -4011,7 +4011,7 @@ This directive is entirely optional\. It\'s not required for proper operation\.
The metadata must be a constant jq expression\. It should be an object with keys like \fBhomepage\fR\. At this time jq doesn\'t use this metadata, but it is made available to users via the \fBmodulemeta\fR builtin\.
.
.SS "modulemeta"
-Takes a module name as input and outputs the module\'s metadata as an object, with the module\'s imports (including metadata) as an array value for the \fBdeps\fR key\.
+Takes a module name as input and outputs the module\'s metadata as an object, with the module\'s imports (including metadata) as an array value for the \fBdeps\fR key and the module\'s defined functions as an array value for the \fBdefs\fR key\.
.
.P
Programs can use this to query a module\'s metadata, which they could then use to, for example, search for, download, and install missing dependencies\.