From 19b0ae4ccf08c88fd8b1a4e83fbaea30e8b71839 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Wed, 16 Sep 2020 12:58:14 -0400 Subject: [PATCH] Add notes about when warnings are issued, closes #133 --- docs/cli/ocds.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/cli/ocds.rst b/docs/cli/ocds.rst index a72065c5..7dc03433 100644 --- a/docs/cli/ocds.rst +++ b/docs/cli/ocds.rst @@ -240,6 +240,10 @@ If you need to create a single package that is too large to hold in your system' For the Python API, see :meth:`ocdskit.combine.combine_record_packages`. +.. note:: + + A warning is issued if a package's ``"records"`` field isn't set. + combine-release-packages ------------------------ @@ -266,6 +270,10 @@ If you need to create a single package that is too large to hold in your system' For the Python API, see :meth:`ocdskit.combine.combine_release_packages`. +.. note:: + + A warning is issued if a package's ``"releases"`` field isn't set. + .. _split-record-packages: split-record-packages