Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restrict symbols in names #43

Merged
merged 7 commits into from
Feb 5, 2025
Merged

Restrict symbols in names #43

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5d42804
Restrict symbols in names
rly Feb 1, 2025
2fe9222
Update source/description.rst
rly Feb 3, 2025
bc156d5
Update source/description.rst
rly Feb 3, 2025
eba0d99
Update source/description.rst
rly Feb 3, 2025
f0f8f2a
Update source/description.rst
rly Feb 3, 2025
ff27d3f
Update source/description.rst
rly Feb 3, 2025
6ecd861
Add restriction to link names
rly Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions source/description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Text description of the namespace.
``name``
^^^^^^^^

Unique name used to refer to the namespace.
Unique name used to refer to the namespace. The name must not contain ":", "/", or whitespace.

``full_name``
^^^^^^^^^^^^^
Expand All @@ -160,7 +160,8 @@ Optional string with extended full name for the namespace.
``version``
^^^^^^^^^^^

Version string for the namespace
Version string for the namespace. The version string must not contain ":" or "/". It should follow
the NWB versioning guidelines: https://www.nwb.org/versioning-guidelines/

``date``
^^^^^^^^
Expand Down Expand Up @@ -270,6 +271,9 @@ Groups are specified as part of the top-level list or via lists stored in the ke
The key/value pairs that make up a group specification are described in more detail next in Section :numref:`sec-group-spec-keys`.
The keys should be ordered as specified above for readability and consistency with the rest of the schema.

The ``name``, ``default_name``, ``{{ data_type_def }}``, and ``{{ data_type_inc }}`` must follow the regular
expression pattern: ``^[A-Za-z_][A-Za-z0-9_]*$`` to ensure compatibility across APIs.

.. note::

In version 3.0, the ``linkable`` key was removed.
Expand Down Expand Up @@ -539,7 +543,8 @@ Attribute specification keys
^^^^^^^^

String with the name for the attribute. The ``name`` key is required and must
specify a unique attribute on the current parent object (e.g., group or dataset)
specify a unique attribute on the current parent object (e.g., group or dataset).
The name must not contain whitespace.

.. _sec-dtype:

Expand Down Expand Up @@ -902,6 +907,8 @@ The key/value pairs that make up a dataset specification are described in more d
:numref:`sec-dataset-spec-keys`. The keys should be ordered as specified above for readability and consistency with the
rest of the schema.

The ``name``, ``default_name``, ``{{ data_type_def }}``, and ``{{ data_type_inc }}`` must not contain ":" or "/".

.. note::

In version 3.0, the ``default_value`` key was removed for datasets. The
Expand Down