Adjust comment from bug 790545's patch
authorGavin Sharp <gavin@gavinsharp.com>
Mon, 08 Oct 2012 10:57:21 +0200
changeset 113257 a4bc614f4092a8ca98ec95694d7720fcc1d3651e
parent 113256 091cda42bc2296358ea7bd886d0984faeae086a2
child 113258 6d20b416c2b750d864f0200415a9d08d70b298de
push id2248
push userakeybl@mozilla.com
push dateMon, 08 Oct 2012 19:23:44 +0000
treeherdermozilla-aurora@118a3b748323 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
bugs790545
milestone18.0a1
Adjust comment from bug 790545's patch
toolkit/components/social/SocialService.jsm
--- a/toolkit/components/social/SocialService.jsm
+++ b/toolkit/components/social/SocialService.jsm
@@ -197,23 +197,24 @@ SocialProvider.prototype = {
     }
   },
 
   // Reference to a workerAPI object for this provider. Null if the provider has
   // no FrameWorker, or is disabled.
   workerAPI: null,
 
   // Contains information related to the user's profile. Populated by the
-  // workerAPI via updateUserProfile. Null if the provider has no FrameWorker.
+  // workerAPI via updateUserProfile.
   // Properties:
   //   iconURL, portrait, userName, displayName, profileURL
   // See https://github.com/mozilla/socialapi-dev/blob/develop/docs/socialAPI.md
   // A value of null or an empty object means 'user not logged in'.
-  // A value of undefined means the service has not told us the status of the
-  // profile, but is expected to soon (ie, the service is still loading/initing)
+  // A value of undefined means the service has not yet told us the status of
+  // the profile (ie, the service is still loading/initing, or the provider has
+  // no FrameWorker)
   // This distinction might be used to cache certain data between runs - eg,
   // browser-social.js caches the notification icons so they can be displayed
   // quickly at startup without waiting for the provider to initialize -
   // 'undefined' means 'ok to use cached values' versus 'null' meaning 'cached
   // values aren't to be used as the user is logged out'.
   profile: undefined,
 
   // Map of objects describing the provider's notification icons, whose