- I am proposing to use
description to document a property and and model defined in LDL. This is consistent with description field used in remoting metadata.
- The
description value can be either a simple string, or an array of strings. The latter is interpreted as a list of lines (i.e. the single string value is produced by joining all items with a new-line character) and it allows developers to write longer description while keeping the line length below 80 chars.
- Remoting metadata should support "array of strings" values too.
Example:
{
"name": "MyModel",
"description": "A model with a description.",
"properties": {
"production": {
"type": "boolean",
"description": [
"Production or development mode. It denotes what default APNS",
"servers to be used to send notifications.",
"See API documentation for more details."
]
}
}
}Tasks
/to @ritch @raymondfeng @fabien thoughts?
/cc @superkhau @altsang
descriptionto document a property and and model defined in LDL. This is consistent withdescriptionfield used in remoting metadata.descriptionvalue can be either a simple string, or an array of strings. The latter is interpreted as a list of lines (i.e. the single string value is produced by joining all items with a new-line character) and it allows developers to write longer description while keeping the line length below 80 chars.Example:
{ "name": "MyModel", "description": "A model with a description.", "properties": { "production": { "type": "boolean", "description": [ "Production or development mode. It denotes what default APNS", "servers to be used to send notifications.", "See API documentation for more details." ] } } }Tasks
description. Possibly support array values for other fields likenotestoo./to @ritch @raymondfeng @fabien thoughts?
/cc @superkhau @altsang