docs: Update readme info on creating model objects #245
Conversation
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
Some of the sample code in the README.md no longer worked after the change for RFC 0002. https://github.com/OpenJobDescription/openjd-specifications/blob/mainline/rfcs/0002-model-extensions.md updated OpenJD to make the fields and validation of template components depend on an 'extensions' property at the top level of the template. Implementing this in the model library involved adding a model parsing context that objects look at during construction and validation. This change adds a docstring for the parse_model function and updates the broken examples to explain how the extensions fit in and how to create model objects. Signed-off-by: Mark <[email protected]>
|
baxeaz
approved these changes
Oct 29, 2025
jusiskin
approved these changes
Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Fixes #238
What was the problem/requirement? (What/Why)
Some of the sample code in the README.md no longer worked after the change for RFC 0002.
https://github.com/OpenJobDescription/openjd-specifications/blob/mainline/rfcs/0002-model-extensions.md updated OpenJD to make the fields and validation of template components depend on an 'extensions' property at the top level of the template. Implementing this in the model library involved adding a model parsing context that objects look at during construction and validation.
What was the solution? (How)
This change adds a docstring for the parse_model function and updates the broken examples to explain how the extensions fit in and how to create model objects.
What is the impact of this change?
All the sample code in README.md works again.
How was this change tested?
I copy/pasted all the code samples into a Jupyter notebook and saw that they worked.
Was this change documented?
It is docs.
Is this a breaking change?
No
Does this change impact security?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.