quotes

avishalom · avishalom · commit 7bde4f22c809 · 2018-03-20T19:15:06.000-04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,6 @@
   for all egress requests. Pass the `httpTimeout` option
   to `firebase_admin.initialize_app()` before invoking any functions in
   `messaging`.
-
 - [added] The Firebase dynamic links module with the `get_link_stats` API.
 
 # v2.9.0
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -177,11 +177,11 @@ Now you can invoke the integration test suite as follows:
 pytest integration/ --cert path/to/service_acct.json --apikey path/to/apikey.txt
 ```
 
-### End to end testing for dynamic links.
+### End-to-End Testing for Dynamic Links.
 
-To run end to end tests for Firebase dynamic links follow these steps:
+To run end-to-end tests for Firebase dynamic links follow these steps:
 
-1. From the firebase console, create a short link under "Grow > Dynamic Links".
+1. From the [`Firebase Console`](https://firebase.corp.google.com/), create a short link in your project under "`Grow` > `Dynamic Links`".
 2. From your browser or phone, go to that short link and see that it redirects as desired.
 3. Wait up to 36 hours for stats to show up on the console.
 4. Create a file at `tests/data/dynamic_links_e2e_url.txt` containing the short link,
diff --git a/firebase_admin/dynamic_links.py b/firebase_admin/dynamic_links.py
@@ -39,18 +39,18 @@
 EVENT_TYPE_APP_RE_OPEN = 'app_re_open'
 
 def get_link_stats(short_link, stat_options, app=None):
-    """ Returns a `LinkStats` object with the event statistics for the given short link
+    """ Returns a ``LinkStats`` object with the event statistics for the given short link
 
     Args:
         short_link: The string of the designated short link. e.g. https://abc12.app.goo.gl/link
                     The link must belong to the project associated with the service account
                     used to call this API.
         stat_options: An object containing a single field "duration_days" for which the statistics
                       are retrieved.
-        app: (optional) `firebase_app` instance. (If missing uses default app.)
+        app: A Firebase ``App instance`` (optional). (If missing uses default app.)
 
     Returns:
-        LinkStats: An `LinkStats` object. (containing an array of `EventStats`)
+        LinkStats: An ``LinkStats`` object. (containing an array of ``EventStats``)
 
     Raises:
         ValueError: If any of the arguments are invalid.
@@ -79,7 +79,7 @@ def _get_link_service(app):
 
 
 class LinkStats(object):
-    """The `LinkStats` object is returned by get_link_stats, it contains a list of `EventStats`"""
+    """The ``LinkStats`` object is returned by get_link_stats, it contains a list of ``EventStats``"""
     def __init__(self, event_stats):
         if not isinstance(event_stats, (list, tuple)):
             raise ValueError('Invalid data argument: {0}. Must be a list or tuple'
@@ -94,12 +94,12 @@ def event_stats(self):
         """Returns the event statistics for this link, for the requested period.
 
         Returns:
-          event_stats: A list of `EventStats`.
+          event_stats: A list of ``EventStats``.
         """
         return self._stats
 
 class EventStats(object):
-    """`EventStats` is a single stat item containing (platform, event, count)"""
+    """``EventStat`` is a single stat item containing (platform, event, count)"""
 
     _platforms = {
         'DESKTOP': PLATFORM_DESKTOP,
diff --git a/integration/test_dynamic_links.py b/integration/test_dynamic_links.py
@@ -25,12 +25,12 @@
 try:
     dynamic_links_e2e_url = testutils.resource('dynamic_links_e2e_url.txt').strip()
 except IOError:
-    sys.stderr.write("\nEnd to end tests not set up, see CONTRIBUTING.md file.\n")
+    sys.stderr.write("\nEnd-to-end tests not set up, see CONTRIBUTING.md file.\n")
 
 @pytest.mark.skipif(not dynamic_links_e2e_url,
-                    reason="End to end tests not set up, see CONTRIBTING.md file.")
+                    reason="End-to-end tests not set up, see CONTRIBTING.md file.")
 class TestEndToEnd(object):
-    """Runs an end to end test, see comment string for setup."""
+    """Runs an end-to-end test, see comment string for setup."""
 
     def test_get_stats(self):
         if not dynamic_links_e2e_url:
