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.

Sign up for GitHub

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

Jump to bottom

Fix documentation of NXaperture #1341

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Fix documentation of NXaperture #1341

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion base_classes/NXaperture.nxdl.xml
View file
Open in desktop
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