Skip to content

Commit

Permalink
Merge pull request #603 from hed-standard/develop
Browse files Browse the repository at this point in the history
getting ready for the release of v3.3.0
  • Loading branch information
VisLab authored Jul 5, 2024
2 parents 17fabb5 + 5bc506c commit 975fbbd
Show file tree
Hide file tree
Showing 8 changed files with 22,068 additions and 1,207 deletions.
1 change: 1 addition & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- This file lists all links/regex to be ignored by lychee in the link checker -->
https://www.sciencedirect.com/science/article/pii/S1053811921010387
https://www.sciencedirect.com/science/article/pii/S0010945221001106
https://www.sciencedirect.com/science/article/pii/S1388245717309069
(_anchor|-anchor)

22 changes: 5 additions & 17 deletions docs/source/Appendix_B.md
Original file line number Diff line number Diff line change
Expand Up @@ -504,23 +504,11 @@ Schema loading errors can occur because the file is inaccessible or is not prope
Schema loading errors are handled in different ways by the Python and JavaScript tools.

Python tools generally raise a `HedFileError` exception when a failure to load the
schema occurs. The calling programs are responsible for deciding how to handle such a
failure.
schema occurs. The calling programs are responsible for deciding how to handle such a failure.

JavaScript tools in contrast are mainly used for validation in HED validation BIDS and
are mainly called by the [BIDS](https://bids.neuroimaging.io/) validator.
Usually BIDS datasets provide a HED version number to designate the version of HED
to be used, and the HED JavaScript validator is
responsible for locating and loading schema.

BIDS validator users do not always have
unrestricted access to the Internet during the validation process. The HED JavaScript
tools have a fallback of the loading of the specified schema fails. The validator loads
an internal copy of the most recent version of the HED schema and loads it. However, it
also reports a `SCHEMA_LOAD_FAILED` issue to alert the user that the schema used
for validation may not be the one designated in the dataset. However, validation will
continue with the fallback schema.

If the fallback schema stored with the HED validator fails to load,
the `SCHEMA_LOAD_FAILED` issue will also be reported and no additional
HED validation will occur.
If a **BIDS dataset uses HED**, it must provide a HED version specification in the`dataset_description.json` file.
If the HED JavaScript validator cannot load a valid HED schema based on this specification
it reports a `SCHEMA_LOAD_FAILED` issue.
A BIDS dataset
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
author = 'HED Working Group'

# The full version, including alpha/beta/rc tags
release = '3.2.0'
version = '3.2.0'
release = '3.3.0'
version = '3.3.0'

currentdir = os.path.abspath(os.path.dirname(__file__))

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ HED specification

.. sidebar:: **Links**

* `PDF released version (V3.2.0) <https://raw.githubusercontent.com/hed-standard/hed-specification/master/hedspec/HEDSpecification_3_2_0.pdf>`_
* `PDF released version (V3.3.0) <https://raw.githubusercontent.com/hed-standard/hed-specification/master/hedspec/HEDSpecification_3_3_0.pdf>`_

* `PDF working version <https://hed-specification.readthedocs.io/_/downloads/en/develop/pdf/>`_

Expand Down
Binary file added hedspec/HEDSpecification_3_3_0.pdf
Binary file not shown.
1,406 changes: 1,406 additions & 0 deletions hedwiki/HED8.3.0.mediawiki

Large diffs are not rendered by default.

Loading

0 comments on commit 975fbbd

Please sign in to comment.