docs: overhaul example workflow and clean it up#1497
Merged
Conversation
saskiad
reviewed
Jul 8, 2025
saskiad
reviewed
Jul 8, 2025
saskiad
reviewed
Jul 8, 2025
saskiad
reviewed
Jul 8, 2025
| |-------|------|-------------| | ||
| | `sex` | [Sex](#sex) | | | ||
| | `date_of_birth` | `datetime.date` | | | ||
| | `date_of_birth` | `typing.Annotated[datetime.date, <TimeValidation.BEFORE: 'before'>]` | | |
Collaborator
There was a problem hiding this comment.
I assume this is autogenerated? I find this not useful to explaining what the field is. But not a deal breaker.
Member
Author
There was a problem hiding this comment.
That's definitely a bug in the generator, should just resolve itself to "datetime.date"
Member
Author
|
Blocked by aind-data-schema-models bug |
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
2 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.
This PR overhauls the
example_workflowto better reflect 2.0 and provide a softer introduction to the schema. You can see this specific branch here: https://aind-data-schema.readthedocs.io/en/1484-20-overhaul-the-generating-metadata-tutorial/PR also adds a few other pending fixes to the documentation, like properly linking the PIDName class