You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This may not end up being possible but I'm creating this issue to track the addition of a means to visualize valkyrie schema for the purposes of inclusion in package documentation.
Current thoughts: Schema define a new method for the purposes of generating content that adequately represents the schema and its requirements. This might only work for the simplest schema without coercions or assertions. Alternatively, this task is left to individual documentation-generator packages as its implementation will depend heavily on the end use-case.
The text was updated successfully, but these errors were encountered:
I think packages could benefit from this when using complex custom types, but I wonder how long this would be beneficial.
My assumption is that many packages will switch to custom types once they are available (which will, as discussed in the community discord, likely also come with automatic type assertions). I wonder if it's worth investing in such a feature if it may not be used much. The only constraints I can think of that valkyrie would then be used for, would be simple constraints like member checks on and fallbacks on dictionaries and range checks on simple types, which are probably all easily written by hand.
This may not end up being possible but I'm creating this issue to track the addition of a means to visualize valkyrie schema for the purposes of inclusion in package documentation.
Current thoughts: Schema define a new method for the purposes of generating content that adequately represents the schema and its requirements. This might only work for the simplest schema without coercions or assertions. Alternatively, this task is left to individual documentation-generator packages as its implementation will depend heavily on the end use-case.
The text was updated successfully, but these errors were encountered: