Add notes about when warnings are issued, closes #133

open-contracting · Sep 16, 2020 · 19b0ae4 · 19b0ae4
1 parent bea0a49
commit 19b0ae4
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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