Merge pull request #73 from reddit/dc_docs

Add DC docs

Author: mrlevitas

docs/index.rst

@@ -59,7 +59,7 @@ Upgrade or integrate reddit-experiments package:
 .. code-block:: python
 
     # import latest reddit-experiments package in service requirements.txt
-    reddit-experiments>=1.3.7
+    reddit-experiments>=1.3.8
 
 Initialize :code:`decider` instance on Baseplate context
 --------------------------------------------------------
@@ -117,7 +117,7 @@ Make sure :code:`EdgeContext` is accessible on :code:`request` object like so:
     #   - locale
     #   - origin_service
     #   - is_employee
-    #   - loid_created_ms
+    #   - loid_created_ms (>=1.3.8)
 
     # Customized fields can be defined below to be extracted from a baseplate request
     # and will override above edge_context fields.
@@ -144,6 +144,11 @@ or optionally, if manual exposure is necessary, use::
         ...
         request.decider.expose(experiment_name='experiment_name', variant_name=variant)
 
+and this is an example of using a dynamic configuration::
+
+    def my_method(request):
+        if request.decider.get_bool("foo") == True:
+            ...
 
 Decider API
 -----------
@@ -171,5 +176,6 @@ Legacy API docs:
 ----------------
 
 .. toctree::
+  :maxdepth: 1
 
   legacy/index

reddit_decider/__init__.py

@@ -782,30 +782,75 @@ def _get_dynamic_config_value(
         return res.val()
 
     def get_bool(self, feature_name: str, default: bool = False) -> bool:
+        """Fetch a Dynamic Configuration of boolean type.
+
+        :param feature_name: Name of the dynamic config you want a value for.
+
+        :param default: what is returned if dynamic config is not active
+            (:code:`False` unless overriden).
+
+        :return: the boolean value of the dyanimc config if it is active/exists, :code:`default` parameter otherwise.
+        """
         decider = self._get_decider()
         if not decider:
             return default
         return self._get_dynamic_config_value(feature_name, decider.get_bool, default)
 
     def get_int(self, feature_name: str, default: int = 0) -> int:
+        """Fetch a Dynamic Configuration of int type.
+
+        :param feature_name: Name of the dynamic config you want a value for.
+
+        :param default: what is returned if dynamic config is not active
+            (:code:`0` unless overriden).
+
+        :return: the int value of the dyanimc config if it is active/exists, :code:`default` parameter otherwise.
+        """
         decider = self._get_decider()
         if not decider:
             return default
         return self._get_dynamic_config_value(feature_name, decider.get_int, default)
 
     def get_float(self, feature_name: str, default: float = 0.0) -> float:
+        """Fetch a Dynamic Configuration of float type.
+
+        :param feature_name: Name of the dynamic config you want a value for.
+
+        :param default: what is returned if dynamic config is not active
+            (:code:`0.0` unless overriden).
+
+        :return: the float value of the dyanimc config if it is active/exists, :code:`default` parameter otherwise.
+        """
         decider = self._get_decider()
         if not decider:
             return default
         return self._get_dynamic_config_value(feature_name, decider.get_float, default)
 
     def get_string(self, feature_name: str, default: str = "") -> str:
+        """Fetch a Dynamic Configuration of string type.
+
+        :param feature_name: Name of the dynamic config you want a value for.
+
+        :param default: what is returned if dynamic config is not active
+            (:code:`""` unless overriden).
+
+        :return: the string value of the dyanimc config if it is active/exists, :code:`default` parameter otherwise.
+        """
         decider = self._get_decider()
         if not decider:
             return default
         return self._get_dynamic_config_value(feature_name, decider.get_string, default)
 
     def get_map(self, feature_name: str, default: Optional[dict] = None) -> Optional[dict]:
+        """Fetch a Dynamic Configuration of map type.
+
+        :param feature_name: Name of the dynamic config you want a value for.
+
+        :param default: what is returned if dynamic config is not active
+            (:code:`None` unless overriden).
+
+        :return: the map value of the dyanimc config if it is active/exists, :code:`default` parameter otherwise.
+        """
         decider = self._get_decider()
         if not decider:
             return default