Skip to content

Order of keys in the NWB source schemas of the NWB Format Specification documentation #621

@ehennestad

Description

@ehennestad

Each of the sections in the NWB Specification Language documentation states a preferred order for specification keys of groups, datasets, attributes and links, i.e

The keys should be ordered as specified above for readability and consistency with the rest of the schema.

Full example:
https://schema-language.readthedocs.io/en/latest/description.html#groups

This ordering is not followed in the NWB Format Specification documentation, for each of the yaml insets in the Schema Sources chapter.

Example here:
https://nwb-schema.readthedocs.io/en/latest/format.html#sec-timeseries-src

Would be great if the same order could be followed in the documentation, as it makes the schemas much easier to read.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: lowalternative solution already working and/or relevant to only specific user(s)topic: docsIssues related to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions