Add description attribute to Model#3956
Merged
GuySten merged 2 commits intoJul 23, 2026
Merged
Conversation
Allow users to attach a free-text description to a Model instance. The description is written as a <description> element in model XML and read back on import. An empty description is omitted from the output.
GuySten
approved these changes
Jul 22, 2026
GuySten
left a comment
GuySten
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me.
@EdenRochmanSharabi, next time please keep the default pull request checklist.
GuySten
added
Other Enhancement
Merging Soon
paulromano
approved these changes
Jul 22, 2026
paulromano
left a comment
paulromano
left a comment
Contributor
There was a problem hiding this comment.
LGTM! Sorry for the delay on this relatively simple PR. Note that I fixed one issue on the branch with respect to XML escaping (modified test illustrates the problem).
@eepeterson @shimwell Do you guys have any opinions on this? If my memory serves me correctly, I feel like some combination of us had discussed this before.
Member
|
I am in favor of meta like this model.description . I think we had chatted about meta data in the nuclear data before which is perhaps related. but yes LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3586.
Adds a
descriptionproperty toModelthat allows users to attacha free-text description to a model instance.
<description>element in model XMLand read back via
from_model_xml.check_type.Tests cover round-trip serialization, empty-description omission, and
empty round-trip.