-
Notifications
You must be signed in to change notification settings - Fork 186
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
Allow Documentation for Lists and Maps #9
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We should allow non-empty lists and maps to be included in the values table with descriptions. This issue asks that we implement the following behavior for values table generation:
default
field for lists and objects in this case should be a jsonified string of the fieldAn example:
Produces
{"keyNoDescription": "value", "keyWithDescription": "value"}
[{"keyNoDescription": "value"}, {"keyWithDescription": "value"}, {"listItemWithDescription": "value"}]
{"listItemWithDescription": "value"}
Note how
exampleListDescription.keyNoDesciption
andexampleObjectDescription.keyNoDescription
aren't documented because the containing object and list themselves have description comments, but the other contained keys are documented because they do have description comments.The text was updated successfully, but these errors were encountered: