add @target attribute to NXobject using new field super-type

[lukaspie]

Summary by Sourcery

Add a new @target attribute to the NXobject base class to support describing connections between fields and groups

New Features:

• Introduce a generic @target attribute that can be used to describe connections between fields and groups, enabling explicit link targeting

Enhancements:

• Modify NXspindispersion to rename 'target' field to 'target_name' to align with the new targeting mechanism

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a @target attribute to the NXobject base class, enabling the description of connections between groups and fields. It also renames the target field in NXspindispersion to target_name to avoid conflicts or confusion.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added a @target attribute to NXobject to describe connections between groups or fields, especially for links.	Added @target(NX_CHAR) attribute to NXobject in the YAML file. Added @target(NX_CHAR) attribute to NXobject in the XML file. Added FIELDNAME(NX_TYPE) definition to allow attributes on fields.	base_classes/nyaml/NXobject.yaml base_classes/NXobject.nxdl.xml
Renamed the target field in NXspindispersion to target_name.	Renamed target field to target_name in the YAML file. Renamed target field to target_name in the XML file.	contributed_definitions/nyaml/NXspindispersion.yaml contributed_definitions/NXspindispersion.nxdl.xml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @lukaspie - I've reviewed your changes - here's some feedback:

Overall Comments:

• The changes to NXspindispersion should be in a separate pull request.
• Consider renaming the attribute to NX_TARGET to follow the NeXus naming convention for attributes.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[mkuehbach]

Looks reasonable to me provided the clarification in the docstring gets added.

Nice to see sourcery being tested in this example for this example here it is too chatty, your docstring to the pr is cleaner and more succinct

[mkuehbach]

I see, now the nesting,
nevertheless for the docstring

"to another {field, group}" add "- its target -"

[lukaspie]

Not sure I understand your point, can you please write out what you want to have?

[mkuehbach]

the concept is called @target and FIELDNAME/@target respectively.
It would be nice to pick this up in the docstring and explain like
concept A (the FIELDNAME or GROUP) has a target that is the pointed to other field or group,
i.e. the target the instance data that are written into the concept attribute @target one points at.

Cuz at some points I was wondering why it is called target and not source.
The idea was that the docstring should clarify the direction of the pointing from one concept to another, therefore I wrote "- its (i.e. concept A's) target - "

[lukaspie]

Ok, makes sense. This is a bit tricky though because for links in HDF5, these are the same object, so for one of them the target attribute will point onto the field/group itself. I added your suggestions, but this language is probably anyway something that NIAC will have to define.

[lukaspie]

Looks reasonable to me poviod he clarification in the docstring gets added.

Nice to see sourcery being tested in this example for this example here it is too chatty, your docstring to the pr is cleaner and more succinct

The summary at the top also gets created by sourcery, so maybe it's not all bad.