Merge pull request #95 from launchdarkly/eb/ch17280/edits

misc. doc comment edits

Author: eli-darkly

ldclient/__init__.py

@@ -32,7 +32,7 @@ def set_config(config):
     re-initialized with the new configuration (this will result in the next call to :func:`ldclient.get()`
     returning a new client instance).
 
-    :param string sdk_key: the new SDK key
+    :param ldclient.config.Config config: the client configuration
     """
     global __config
     global __client
@@ -93,7 +93,7 @@ def get():
     """Returns the shared SDK client instance, using the current global configuration.
 
     To use the SDK as a singleton, first make sure you have called :func:`ldclient.set_sdk_key()` or
-    :func:`ldclient.set_config()` at startup time. Then `get()` will return the same shared
+    :func:`ldclient.set_config()` at startup time. Then ``get()`` will return the same shared
     :class:`ldclient.client.LDClient` instance each time. The client will be initialized if it has
     not been already.
 

ldclient/client.py

@@ -71,10 +71,6 @@ class LDClient(object):
     def __init__(self, sdk_key=None, config=None, start_wait=5):
         """Constructs a new LDClient instance.
 
-        Rather than calling this constructor directly, you can call the `ldclient.set_sdk_key`,
-        `ldclient.set_config`, and `ldclient.get` functions to configure and use a singleton
-        client instance.
-
         :param string sdk_key: the SDK key for your LaunchDarkly environment
         :param ldclient.config.Config config: optional custom configuration
         :param float start_wait: the number of seconds to wait for a successful connection to LaunchDarkly
@@ -203,7 +199,7 @@ def is_offline(self):
     def is_initialized(self):
         """Returns true if the client has successfully connected to LaunchDarkly.
 
-        :rype: bool
+        :rtype: bool
         """
         return self.is_offline() or self._config.use_ldd or self._update_processor.initialized()
 

ldclient/config.py

@@ -166,9 +166,8 @@ def copy_with_new_sdk_key(self, new_sdk_key):
                       user_keys_flush_interval=self.__user_keys_flush_interval,
                       inline_users_in_events=self.__inline_users_in_events)
 
+    # for internal use only - probably should be part of the client logic
     def get_default(self, key, default):
-        """Used internally by the SDK client to get the default value for a flag.
-        """
         return default if key not in self.__defaults else self.__defaults[key]
 
     @property
@@ -179,22 +178,22 @@ def sdk_key(self):
     def base_uri(self):
         return self.__base_uri
 
+    # for internal use only - also no longer used, will remove
     @property
     def get_latest_flags_uri(self):
-        """Used internally, deprecated.
-
-        .. deprecated:: 5.0.0
-        """
         return self.__base_uri + GET_LATEST_FEATURES_PATH
 
+    # for internal use only - should construct the URL path in the events code, not here
     @property
     def events_uri(self):
         return self.__events_uri + '/bulk'
 
+    # for internal use only
     @property
     def stream_base_uri(self):
         return self.__stream_uri
 
+    # for internal use only - should construct the URL path in the streaming code, not here
     @property
     def stream_uri(self):
         return self.__stream_uri + STREAM_FLAGS_PATH

ldclient/flag.py

@@ -45,7 +45,7 @@ def variation_index(self):
         """The index of the returned value within the flag's list of variations, e.g.
         0 for the first variation -- or None if the default value was returned.
 
-        :rtype: int
+        :rtype: int or None
         """
         return self.__variation_index
 

ldclient/flags_state.py

@@ -63,7 +63,7 @@ def get_flag_reason(self, key):
         :param string key: the feature flag key
         :return: a dictionary describing the reason; None if reasons were not recorded, or if there was no
           such flag
-        :rtype: dict
+        :rtype: dict or None
         """
         meta = self.__flag_metadata.get(key)
         return None if meta is None else meta.get('reason')