Skip to content

Commit

Permalink
Update documentation on validation to warn that the example does not …
Browse files Browse the repository at this point in the history
…work.

Ref hdmf-dev#473
  • Loading branch information
dsleiter committed Dec 2, 2020
1 parent df96407 commit 430e041
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/source/validation.rst
Expand Up @@ -3,6 +3,14 @@
Validating HDMF data
====================

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.

--------

.. warning::

THE FOLLOWING IS NOT YET IMPLEMENTED. If you would like to validate HDMF structured data directly through :py:mod:`~hdmf`, then please upvote `this issue <https://github.com/hdmf-dev/hdmf/issues/473>`_.

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
Expand Down

0 comments on commit 430e041

Please sign in to comment.