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

Documentation of links to be improved #388

Closed
prjemian opened this issue Feb 12, 2015 · 1 comment
Closed

Documentation of links to be improved #388

prjemian opened this issue Feb 12, 2015 · 1 comment

Comments

@prjemian
Copy link
Contributor

The documentation of links in data files can be improved.

On 2/12/2015 10:39 AM, Andrew GOETZ wrote:

A second question we had is that the way the application definitions are
defined today implies they duplicate data in the file instead of linking
to it. This is because they insist on creating NXsubentry. Please
correct me if we have misunderstood the use of NXsubentry.

"Implies" -- the whole process needs some documentation that describes how links can be used to reduce duplication (and size) in NeXus data files.

Enrich the documentation of links and then add some text at the beginning of the NXDL application definitions chapter to state that links can (and probably should) be used whenever possible to reduce duplication.

@prjemian
Copy link
Contributor Author

prjemian commented Jun 25, 2017

This issue is about when to use NXsubentry as much as it is about NeXus links. See #582.

Completion of the suggestion to promote the recommendation of links will satisfy this issue.

prjemian added a commit that referenced this issue Jun 25, 2017
prjemian added a commit that referenced this issue Jun 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant