TIDOC-360 TIDOC-136: Make corrections to templates #1353

Merged
merged 2 commits into from Feb 8, 2012

Conversation

Projects
None yet
3 participants
parameters:
- name: parameters
type: Dictionary<${data["proxy_name"]}>
- summary: (Optional) A dictionary object with properties as defined in <${data["proxy_name"]}>.
+ summary: (Optional) Properties as defined in <${data["proxy_name"]}>.
@arthurevans

arthurevans Feb 7, 2012

Contributor

I think this should say, "Dictionary object with properties..." Or go whole hog and say,

"Dictionary specifying properties to set on the new object. This can include any properties defined by <${data["proxy_name"]}> except those marked not-creation or read-only."

Also, please remove the (Optional) tag and add an optional: true annotation so this parameter appears like other optional parameters. There's an open bug for this (TIDOC-136).

@hal-gh

hal-gh Feb 7, 2012

Contributor

Fixed.
Note. as "Dictionary" is already explained by the type, I've omitted this word from the description.

Contributor

arthurevans commented Feb 7, 2012

CR'd. Approved.
Need a CR/FT from engineering.

Contributor

sptramer commented Feb 8, 2012

Will CR+FR.

Contributor

sptramer commented Feb 8, 2012

Docs reviewed. APPROVED.

Contributor

sptramer commented Feb 8, 2012

Functional tested; ran docgen. APPROVED.

sptramer pushed a commit that referenced this pull request Feb 8, 2012

Stephen Tramer
Merge pull request #1353 from hal-gh/TIDOC-360
TIDOC-360 TIDOC-136: Make corrections to templates

@sptramer sptramer merged commit 660b507 into appcelerator:master Feb 8, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment