ak.validity_error
-----------------

.. py:module: ak.validity_error

Defined in `awkward.operations.ak_validity_error <https://github.com/scikit-hep/awkward/blob/1f270435b3b969ae9b544a2d5788414723af534f/src/awkward/operations/ak_validity_error.py>`__ on `line 12 <https://github.com/scikit-hep/awkward/blob/1f270435b3b969ae9b544a2d5788414723af534f/src/awkward/operations/ak_validity_error.py#L12>`__.

.. py:function:: ak.validity_error(array, *, exception=False)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param exception: If True, validity errors raise exceptions.
    :type exception: bool

Returns an empty string if there are no errors and a str containing the error message
if there are.

Checks for errors in the structure of the array, such as indexes that run
beyond the length of a node's ``content``, etc. Either an error is raised or
a string describing the error is returned.

See also :py:obj:`ak.is_valid`.