-
Notifications
You must be signed in to change notification settings - Fork 8
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
Xrd modification #274
Xrd modification #274
Conversation
a431eb4
to
b766d12
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The quantity labels look good to me. I am not sure about the descriptions of the scatter vector components. If you took it from a reputable source, then it's okay, otherwise please check it with an expert in Area B, perhaps Sandor.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I cannot say anything about the scientific reasonability of these fields. From my very limited knowledge of XRD this reads fine though.
I left some comments on how to deal with links. Here is an example how we formulate this in NXmpes.
ca24b20
to
2948b07
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some more wording suggestions.
Generally, this addresses these points throughout:
- Avoid general phrases as
This concept represents ...
. It is clear that this is explaining the concept and it makes getting the relevant information quickly harder. - Avoid referring to something as
... this is a link to...
, because we cannot enforce linking on the appdef level. We can just suggest to the user to link this data when writing the file. I would therefore suggest to word this as... this should be linked to...
(for same-as concepts) or... this might be linked to ...
(for similar concepts which are the same in some cases but not in others).
You might also want to add some literature which explains the scientific background of, e.g., q-vectors. However, I do believe this is not strictly necessary as we always assume that users of the appdef are also experts in the fields (but it cannot hurt if non-experts can also gain some understanding).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I second what @domna commented, some more suggestions
Co-authored-by: Florian Dobener <[email protected]>
Co-authored-by: Florian Dobener <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from my side now. Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Found one more instance where things can be shortened. Other than that LGTM.
EDIT: there seems to be some intendation problem which prevents the html from being build. Please fix before mergin.
two_theta_plot
compatible with the ELNXRDDiffraction schema.