blackberry-webworks/WebWorks-API-Docs — pull request #208 by allanclara (2012-10-24 20:52:38+00:00)
Title: Updates to BBM files based on proofread of comments.

I proofread the comments in all of the BBM API files. The content was really clean, so I made only minor, non-critical changes; please review and accept as you see fit. I did notice two other issues that really should be fixed, and no doubt you know about them already.

1. Titles that don't include spaces are cut off. This happens when the title is the API name, such as blackberry.bbm.platform.self.profilebox.ProfileBoxItem. This is a microsite problem, but would it be possible to insert a line break in the title? These are the affected files:

https://developer.blackberry.com/html5/apis/blackberry.bbm.platform.io.incomingjoinrequest.html
https://developer.blackberry.com/html5/apis/blackberry.bbm.platform.io.outgoingjoinrequest.html
https://developer.blackberry.com/html5/apis/blackberry.bbm.platform.self.profilebox.profileboxitem.html
https://developer.blackberry.com/html5/apis/blackberry.bbm.platform.users.bbmplatformuser.html

2. Tables are also cutoff due to the fixed width issue. I think this is a known issue, but is there any way to raise the priority with the microsite guys?

Other random things
- In the blackberry_bbm_platform.js file, in the code sample on line 262, there's a reference to TPA. Can we explain what that is? That's the only time TPA appears.
- I removed instances of "to which" and ended some sentences with "to". Although it's traditionally incorrect to end a sentence with a preposition, it's also overly formal, and we want to avoid that kind of formality.

Thanks, and please let me know if you have any concerns or questions.
Clara
callan@rim.com