-
Notifications
You must be signed in to change notification settings - Fork 159
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
[ENH] Render valid value restrictions in tables based on object definitions in schema #921
Conversation
@effigies is this in line with what you were hoping for? |
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. |
Okay, I'll scale it back to only include enums then. |
Dropped types include anyOfs, pattern strings, format strings, and arrays.
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 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.
@sappelhoff done! |
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.
Thanks! LGTM now
Closes #912.
Changes proposed:
schemacode.utils
, calleddescribe_valid_values
, that creates a string describing valid values for an object based on the schema.iEEGCoordinateSystem
much 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.