Update documentation to reflect new defs field on modulemeta

This commit is contained in:
Alex Wilson authored and Nico Williams committed 2023-08-12 20:46:36 -05:00
1 parent 65ed95c93a
commit f31c180e8f
2 files changed
+3 -2

No files matched your search

+2 -1
View File
@@ -3633,7 +3633,8 @@ sections:
Takes a module name as input and outputs the module's metadata Takes a module name as input and outputs the module's metadata
as an object, with the module's imports (including 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 Programs can use this to query a module's metadata, which they
could then use to, for example, search for, download, and could then use to, for example, search for, download, and
Generated
+1 -1
View File
@@ -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\. 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" .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 .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\. 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\.