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.

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

Mark namefitted group as undocumented #570

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

lukaspie
Copy link
Collaborator

@lukaspie lukaspie commented Mar 3, 2025

@rettigl with this PR, we get an "is written without documentation" warning if a variadic concept name is used that is not part of the application definition.

I decided to reuse the undocumented warning here because this can be turned off with a flag in the CLI call of dataconverter. So if somebody is sure that they want to use this namefit anyway, we can just allow that by passing the `ignore-undocumented´ flag.

Fixes #563

@lukaspie lukaspie requested a review from rettigl March 3, 2025 10:25
@lukaspie lukaspie linked an issue Mar 3, 2025 that may be closed by this pull request
Copy link
Collaborator

@rettigl rettigl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change seems to work, however it forces now the NAME[instance] notation also for variadic Fields. In fact, I support this, as previously namefitting was sometimes not correct.

One improvement I suggest is to add a separate clause for NXcollections. These can as I understand it appear anywhere:

"This is the NXcollection class which can appear anywhere underneath NXentry"

Comment on lines +764 to +769
# if not ignore_undocumented:
# collector.collect_and_log(
# not_visited_key,
# ValidationProblem.UnitWithoutDocumentation,
# mapping[not_visited_key],
# )
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This indeed referred to the parent field of an attribute, which gets checked separately. I think we can remove it entirely.

@rettigl
Copy link
Collaborator

rettigl commented Mar 3, 2025

I used NXroot before to write nexus files w/o schema. These give warnings now, see igor-reader tests. Maybe this is fine.

@rettigl
Copy link
Collaborator

rettigl commented Mar 3, 2025

Mpes test failures are all with PROCESS_MPES, which should be removed anyways, so this will be resolved later.

@rettigl
Copy link
Collaborator

rettigl commented Mar 3, 2025

I used NXroot before to write nexus files w/o schema. These give warnings now, see igor-reader tests. Maybe this is fine.

Ah no, NXroot contains NXentry. The issue is that we need ENTRY[scan...]/DATA[data]/DATA[data] now.

@lukaspie lukaspie linked an issue Mar 4, 2025 that may be closed by this pull request
@rettigl
Copy link
Collaborator

rettigl commented Mar 5, 2025

@lukaspie Maybe we merge this into #554, fix the tests accordingly, and once the new definitions are out, merge this into master? Or do you think it makes sense fixing reader tests now before the new release comes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants