nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 56 forks source link

html docs don't seem to match version v2022.07 #1228

Closed soph-dec closed 1 year ago

soph-dec commented 1 year ago

It looks like the html docs were built with a newer version than v2022.07.

For example, the total_flux field in NXmx is required in v2022.07: https://github.com/nexusformat/definitions/blob/v2022.07/applications/NXmx.nxdl.xml#L828 But in the online documentation it is optional (and also two more flux fields are present): https://manual.nexusformat.org/classes/applications/NXmx.html#nxmx-entry-instrument-beam-total-flux-field

Another example is in NXdata, where the field errors is marked deprecated in the online docs: https://manual.nexusformat.org/classes/base_classes/NXdata.html#nxdata-errors-field But in the v2022.07 it is not marked as deprecated: https://github.com/nexusformat/definitions/blob/v2022.07/base_classes/NXdata.nxdl.xml#L377 (The deprecation note was added in mid-September in this commit)

Could it be that there is a version tag missing? Or were the newer docs published by accident?

phyy-nx commented 1 year ago

Hi, no the newer docs are right, they are more up to date than the v2022.07 release.

From Dec 2 2022 telco, there are 3 points to address:

phyy-nx commented 1 year ago

Thanks @soph-dec for the questions. We've discussed this at the telco and included the notes in #1021 and #1230. Ok to close this issue?

soph-dec commented 1 year ago

Thank you for the answer, I understand. Sure, I'll close this and simply watch the other issues!