From: Nicolas Williams <nico@cryptonector.com>
Date: Fri, 10 Jul 2015 15:11:30 +0000 (-0500)
Subject: Simplify import docs
X-Git-Tag: jq-1.5rc2~26
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=fa45a5121c2b2af03190e88bfde0a35111786ba7;p=jq

Simplify import docs
---

diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml
index d18fc1a..2fa890b 100644
--- a/docs/content/3.manual/manual.yml
+++ b/docs/content/3.manual/manual.yml
@@ -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,42 +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 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`.
+          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>;`"
+      - title: "`import RelativePathString as $NAME [<metadata>];`"
         body: |
 
           Imports a JSON file found at the given path relative to a
@@ -2827,11 +2818,11 @@ sections:
           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