Merge changes to Design Principles #12
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generated by TeXShop
I think “This is a very important use case” is implied by the fact that it is the first purpose in the abstract. I’ve also added a reference to the original NeXus paper in 1997, and to NeXpy in the .bib file (not in the text yet).
The most substantive changes are (i) shift NXdata description above NXmonitor, since it’s more important. (ii) make it clear that not all data in NXdata groups are linked. (iii) describe the NXmonitor group, without apologizing for its location in the NXentry groups (since I don’t feel an apology is necessary, and it’s probably unwise when you are promoting the format). This is the right place for, e.g., all pulsed neutron experiments.
In one case, “The HDF Group” was rendered as “T. H. Group”. Authors like “cansas” are too poorly defined to be of use in an archived journal.
The existing version did not, IMHO, give enough of an overview for a new reader.
These are a few changes resulting from the comments by Pete Jemian. I have restored a sentence about using basic HDF5 storage elements, changed ‘peculiar’ to ‘particular’, modified the sentence on using NXDL for validation, and added ‘according to context’ in the application definition section.
Also, corrected ‘follows’ to ‘follow’ in the first sentence of the Design Principles.
|
@rayosborn Is this PR still valid? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I didn't issue a Pull request before to give time for people to comment. I've made some improvements suggested by Pete Jemian, but I've not had much other feedback. The merge will be more problematic if we don't do it soon. Any comments?