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.

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

clarify use of the symbols table in a NXDL file #1000

Closed
prjemian opened this issue Mar 3, 2022 · 3 comments · Fixed by #1074
Closed

clarify use of the symbols table in a NXDL file #1000

prjemian opened this issue Mar 3, 2022 · 3 comments · Fixed by #1074

Comments

@prjemian
Copy link
Contributor

prjemian commented Mar 3, 2022

The symbols table documentation would benefit from more guidance, as suggested in the symbol - for any levels including 'root'? item of nexusformat/NIAC#107.

@prjemian prjemian added this to the NXDL 2022.03 milestone Mar 3, 2022
@prjemian
Copy link
Contributor Author

prjemian commented Mar 3, 2022

Describe why it is at the top level of a NXDL file: to avoid name collision and document each symbol that is used

@prjemian
Copy link
Contributor Author

prjemian commented Mar 3, 2022

Such as this table from h5py.

@prjemian
Copy link
Contributor Author

This might be a good addition to the Symbols table section of defs_intro.rst:

Any symbol used in a NXDL file should be defined in the symbols table.

Also add to this documentation:

definitions/nxdl.xsd

Lines 201 to 209 in 61c2b2a

<xs:element name="symbols" type="nx:symbolsType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Use a ``symbols`` list
to define each of the mnemonics that
represent the length of each dimension in a vector or array.
</xs:documentation>
</xs:annotation>
</xs:element>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants