Skip to content

Commit

Permalink
Fix documentation of NXaperature (#1341)
Browse files Browse the repository at this point in the history
- NXaperature was marked as deprecated but it is not, so fix the documentation
- Explicitly add an unammed NXoff_geometry field, the existence of which was implied by the GEOMETRY deprecation
  • Loading branch information
phyy-nx authored Feb 8, 2024
1 parent 14804e0 commit 8f5c7e8
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion base_classes/NXaperture.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
name="NXaperture"
type="group" extends="NXobject">

<doc>A beamline aperture. This group is deprecated, use NXslit instead.</doc>
<doc>
A beamline aperture.

Note, the group was incorrectly documented as deprecated, but it is not and it is in common use.</doc>
<!-- TODO compare with "screens" in SHADOW -->

<field name="depends_on" type="NX_CHAR">
Expand Down Expand Up @@ -56,6 +59,11 @@
other component groups.
</doc>
</group>
<group type="NXoff_geometry">
<doc>
Use this group to describe the shape of the aperture
</doc>
</group>
<group type="NXgeometry" deprecated="Use the field `depends_on` and :ref:`NXtransformations` to position the aperture and :ref:`NXoff_geometry` to describe its shape">
<doc>
location and shape of aperture
Expand Down

0 comments on commit 8f5c7e8

Please sign in to comment.