Skip to content
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

Better representation (or include more details) for description #480

Open
afsalthaj opened this issue Jan 3, 2021 · 0 comments
Open

Better representation (or include more details) for description #480

afsalthaj opened this issue Jan 3, 2021 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@afsalthaj
Copy link
Collaborator

afsalthaj commented 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”)

@afsalthaj afsalthaj changed the title Better representation for description Better representation (or include more details) for description Jan 3, 2021
@afsalthaj afsalthaj added enhancement New feature or request good first issue Good for newcomers labels May 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant