mirror/stedolan-jq
1
0
Fork 0
mirror of https://github.com/stedolan/jq.git synced 2024-05-11 05:55:39 +00:00
Code Issues Releases Activity

Simplify import docs

Browse Source
This commit is contained in:
Nicolas Williams
2015-07-10 10:11:30 -05:00
parent 862566a48f
commit fa45a5121c
1 changed files with 27 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/content/3.manual/manual.yml
View File

@ -2777,6 +2777,7 @@ sections:
If "$HOME/.jq" is a file, it is sourced into the main program.
entries:
- title: "`import RelativePathString as NAME [<metadata>];`"
body: |
Imports a module found at the given path relative to a
@ -2784,34 +2785,32 @@ sections:
the relative path string. The module's symbols are prefixed
with "NAME::".
- title: "`import RelativePathString;`"
body: |
Imports a module found at the given path relative to a
directory in a search path. A ".jq" suffix will be added to
the relative path string. The module's symbols are imported
into the caller's namespace as if the module's content had
been included directly.
- title: "`import RelativePathString as NAME <metadata>;`"
body: |
Imports a module found at the given path relative to a
directory in a search path. A ".jq" suffix will be added to
the relative path string. The module's symbols are prefixed
with "NAME::".
The metadata must be a constant jq expression. It should be
an object with keys like "homepage" and so on. At this time
jq only uses the "search" key/value of the metadata. The
metadata is also made available to users via the `modulemeta`
builtin.
The optional metadata must be a constant jq expression. It
should be an object with keys like "homepage" and so on. At
this time jq only uses the "search" key/value of the metadata.
The metadata is also made available to users via the
`modulemeta` builtin.
The "search" key in the metadata, if present, should have a
string or array value (array of strings); this is the search
path to be prefixed to the top-level search path.
- title: "`import RelativePathString as $NAME;`"
- title: "`import RelativePathString [<metadata>];`"
body: |
Imports a module found at the given path relative to a
directory in a search path as if it were included in place. A
".jq" suffix will be added to the relative path string. The
module's symbols are imported into the caller's namespace as
if the module's content had been included directly.
The optional metadata must be a constant jq expression. It
should be an object with keys like "homepage" and so on. At
this time jq only uses the "search" key/value of the metadata.
The metadata is also made available to users via the
`modulemeta` builtin.
- title: "`import RelativePathString as $NAME [<metadata>];`"
body: |
Imports a JSON file found at the given path relative to a
@ -2819,19 +2818,11 @@ sections:
the relative path string. The file's data will be available
as `$NAME::NAME`.
- title: "`import RelativePathString as $NAME <metadata>;`"
body: |
Imports a JSON file found at the given path relative to a
directory in a search path. A ".json" suffix will be added to
the relative path string. The file's data will be available
as `$NAME::NAME`.
The metadata must be a constant jq expression. It should be
an object with keys like "homepage" and so on. At this time
jq only uses the "search" key/value of the metadata. The
metadata is also made available to users via the `modulemeta`
builtin.
The optional metadata must be a constant jq expression. It
should be an object with keys like "homepage" and so on. At
this time jq only uses the "search" key/value of the metadata.
The metadata is also made available to users via the
`modulemeta` builtin.
The "search" key in the metadata, if present, should have a
string or array value (array of strings); this is the search