[ENH] Render valid value restrictions in tables based on object definitions in schema#921
Merged
sappelhoff merged 13 commits intobids-standard:masterfrom Feb 1, 2022
Merged
Conversation
3 tasks
Member
Author
|
Some highlights: Restrictions on numbers are shown
Restrictions on arrays (and their items!)
Objects with many possible restricted values can end up being a bit much
No restrictions beyond type means no added text
I haven't tackled
|
Member
Author
|
@effigies is this in line with what you were hoping for? |
Collaborator
|
Much of this is covered by the type, already, or more clearly written in the description. The enumeration of a finite set of possible values seems like the one that's really useful. |
Member
Author
|
Okay, I'll scale it back to only include enums then. |
Dropped types include anyOfs, pattern strings, format strings, and arrays.
sappelhoff
reviewed
Jan 15, 2022
Member
There was a problem hiding this comment.
I like this feature (the downscaled, current version). However, if we want to merge this, we should go over the description texts and make sure the description is not duplicating the allowed values in an unnecessary way. As for example here:
Those values will automatically be rendered from the associated enums.
Member
Author
|
@sappelhoff done! |
yarikoptic
approved these changes
Jan 31, 2022
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 #912.
Changes proposed:
schemacode.utils, calleddescribe_valid_values, that creates a string describing valid values for an object based on the schema.iEEGCoordinateSystemmuch easier.To do:
Figure out how objects should be described.Dropped.Figure out how anyOf situations should be described.Dropped.Some cases will just be too complicated to describe automatically. How should we handle those?Dropped.