Update documentation on validation to warn that the example does not …

…work (#482)

CHANGELOG.md

@@ -46,6 +46,7 @@
 - Fix use of `hdmf.testing.assertContainerEqual(...)` for `Data` objects. @rly (#445)
 - Add missing support for data conversion against spec dtypes "bytes" and "short". @rly (#456)
 - Clarify the validator error message when a named data type is missing. @dsleiter (#478)
+- Update documentation on validation to indicate that the example command is not implemented @dsleiter (#482)
 
 ## HDMF 2.2.0 (August 14, 2020)
 

docs/source/validation.rst

@@ -3,11 +3,22 @@
 Validating HDMF data
 ====================
 
-Validating HDMF structured data is is handled by a command-line tool available in :py:mod:`~hdmf`. The validator can be invoked like so:
+Validation is of NWB files is available through :py:mod:`~pynwb`. See the `PyNWB documentation
+<https://pynwb.readthedocs.io/en/stable/validation.html>`_ for more information.
 
-.. code-block:: bash
+--------
 
-    python -m hdmf.validate -p namespace.yaml test.h5
+.. note::
+
+   A simple interface for validating HDMF structured data through the command line like for PyNWB files is not yet
+   implemented. If you would like this functionality to be available through :py:mod:`~hdmf`, then please upvote
+   `this issue <https://github.com/hdmf-dev/hdmf/issues/473>`_.
 
-This will validate the file ``test.h5`` against the specification in ``namespace.yaml``.
+..
+    Validating HDMF structured data is is handled by a command-line tool available in :py:mod:`~hdmf`. The validator can be invoked like so:
 
+    .. code-block:: bash
+
+        python -m hdmf.validate -p namespace.yaml test.h5
+
+    This will validate the file ``test.h5`` against the specification in ``namespace.yaml``.