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

Jump to bottom

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

Merged
merged 2 commits into from Feb 8, 2012
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
589b277
TIDOC-360: Make corrections to templates
hal-gh Feb 6, 2012
5d17eb1
TIDOC-360 TIDOC-136: Make corrections to templates rev1
hal-gh Feb 7, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions apidoc/templates/create_proxy_method.yml.mako
View file
Open in desktop
@@ -1,10 +1,10 @@
---
name: create${data["proxy_name"].split(".")[-1]}
summary: Create and return an instance of <${data["proxy_name"]}>.
summary: Creates and returns an instance of <${data["proxy_name"]}>.
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"]}>.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

returns:
type: ${data["proxy_name"]}
% if "platforms" in data:
Expand Down
4 changes: 2 additions & 2 deletions apidoc/templates/vsdoc/method.vsdoc.html
View file
Open in desktop
Expand Up @@ -5,14 +5,14 @@
return safeWord.get(str,str)

def getReturnType(str, defaultValue):
needle = 'create and return an instance of '
needle = 'Creates and returns an instance of '
if needle in str:
return re.split(needle,str)[-1]
else:
return defaultValue

def getTypeInstance(str, defaultValue):
needle = 'create and return an instance of '
needle = 'Creates and returns an instance of '
if needle in str:
return 'new ' + re.split(needle,str)[-1] + '()'
else:
Expand Down