From 996491ebed2af5cec9ea02a2efc18eb30f5cd116 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Fri, 28 Feb 2020 18:09:39 -0500 Subject: [PATCH] Fix some typos in the documentation, and simplify the examples for --root-path --- docs/cli/ocds.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/cli/ocds.rst b/docs/cli/ocds.rst index 7a1a2040..e143150d 100644 --- a/docs/cli/ocds.rst +++ b/docs/cli/ocds.rst @@ -37,7 +37,7 @@ If you are working with files that embed OCDS data, use the ``--root-path ROOT_P ] } -You can run ``ocdskit --root-path results.items`` to process the release packages. To build the root path, in this case, you join the ``results`` key to the ``item`` literal by a period (the ``item`` literal indicates that the items to process are in an array). +You can run ``ocdskit --root-path results`` to process the release packages. The root path, in this case, is simply the ``results`` key. OCDS Kit will then process each release package in the ``results`` array. For this next example, you can run ``ocdskit --root-path results.item.ocdsReleasePackage``: @@ -59,6 +59,8 @@ For this next example, you can run ``ocdskit --root-path results.item. ] } +To build the root path, in this case, you join the ``results`` key to the ``item`` literal by a period (the ``item`` literal indicates that the items to process are in an array), and then to the ``ocdsReleasePackage`` key. + detect-format ------------- @@ -119,7 +121,7 @@ OCDS 1.0 `describes