-
Notifications
You must be signed in to change notification settings - Fork 19
feat: Section and Sectioning #1695
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
feat: Section and Sectioning #1695
Conversation
|
|
||
| class Section(DataModel): | ||
| """Description of a slice of brain tissue""" | ||
| """Description of a single section of brain tissue""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's specify that this should not be used for slices and point to the PlanarSectioning for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
|
|
||
| output_specimen_id: str = Field(..., title="Specimen ID") | ||
| targeted_structure: Optional[BrainStructureModel] = Field(default=None, title="Targeted structure") | ||
| includes_surrounding_tissue: Optional[bool] = Field( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it possible to indicate which of these fields will become required in v3.0 (similar to how we mark the deprecated fields)? It might just help to get that information so future upgrades will be easier. (and so we remember to make them required)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather track this with tickets #1723
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Users won't see the tickets, so they won't know to include fields that will be required in the future. But, users also don't read the schema ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to how we do deprecation messages we can also do "v3" messaging so it shows up in the documentation that this will be a required field in the future. If we do that we should do a pass over the whole schema to add those flags everywhere we can find them though. Do you want to open a ticket for that work? We probably have to do it together
saskiad
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just some questions - still remembering how this works
This PR introduces
SectionandSectioninginto Procedures in a backward compatible way (the old Section is now PlanarSection).