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
Since we are concatenating descriptions, it may confuse user when it comes to nested structure, for instance, a description may be applied to only a parent key.
For example, if a is optional and a.b is of the type string then the description of a.b should be “a is optional value, a.b is of the type string”. This is useful especially in error reporting. As of now, the if a.b is missing, corresponding description is “optional value, value of type string”.
This is reasonably easy to change in Read and Write module. Probably summoning description through read/write module should be through Map[List[K], List[String]] allowing Map(“a” -> “optional”, “a.b” -> “aws region, type string”)
The text was updated successfully, but these errors were encountered:
afsalthaj
changed the title
Better representation for description
Better representation (or include more details) for description
Jan 3, 2021
Since we are concatenating descriptions, it may confuse user when it comes to nested structure, for instance, a description may be applied to only a parent key.
For example, if a is optional and a.b is of the type string then the description of a.b should be “a is optional value, a.b is of the type string”. This is useful especially in error reporting. As of now, the if a.b is missing, corresponding description is “optional value, value of type string”.
This is reasonably easy to change in Read and Write module. Probably summoning description through read/write module should be through Map[List[K], List[String]] allowing Map(“a” -> “optional”, “a.b” -> “aws region, type string”)
The text was updated successfully, but these errors were encountered: