github data access usage docs

Signed-off-by: Adrian Edwards <[email protected]>

Author: MoralCode

augur/tasks/github/util/github_data_access.py

@@ -37,6 +37,9 @@ def __init__(self, message="Resource returned HTTP 410 Gone. It is likely intent
 
 class GithubDataAccess:
     """Utilities for accessing the GitHub REST API
+    
+    Public facing functions in this class should refrain from returning data in a structure
+    that is derived from githubs API responses to keep all platform-specific parsing here.
     """
 
     def _base_domain(self) -> str: