Update search submodule for consistency with docs

sigmavirus24 · sigmavirus24 · commit c74e5c03fde2 · 2018-03-02T06:00:02.000-06:00
diff --git a/github3/github.py b/github3/github.py
@@ -1320,7 +1320,7 @@ def search_code(self, query, sort=None, order=None, per_page=None,
 
     def search_issues(self, query, sort=None, order=None, per_page=None,
                       text_match=False, number=-1, etag=None):
-        """Find issues by state and keyword
+        """Find issues by state and keyword.
 
         The query can contain any combination of the following supported
         qualifers:
diff --git a/github3/search/code.py b/github3/search/code.py
@@ -1,40 +1,65 @@
 # -*- coding: utf-8 -*-
+"""Code search results implementation."""
 from __future__ import unicode_literals
 
 from .. import models
 from .. import repos
 
 
 class CodeSearchResult(models.GitHubCore):
+    """A representation of a code search result from the API.
 
-    def _update_attributes(self, data):
-        self._api = self._get_attribute(data, 'url')
+    This object has the following attributes:
+
+    .. attribute:: git_url
+
+        The URL to retrieve the blob via Git
+
+    .. attribute:: html_url
+
+        The URL to view the blob found in a browser.
+
+    .. attribute:: name
+
+        The name of the file where the search result was found.
 
-        #: Filename the match occurs in
-        self.name = self._get_attribute(data, 'name')
+    .. attribute:: path
 
-        #: Path in the repository to the file
-        self.path = self._get_attribute(data, 'path')
+        The path in the repository to the file containing the result.
 
-        #: SHA in which the code can be found
-        self.sha = self._get_attribute(data, 'sha')
+    .. attribute:: repository
 
-        #: URL to the Git blob endpoint
-        self.git_url = self._get_attribute(data, 'git_url')
+        A :class:`~github3.repos.repo.ShortRepository` representing the
+        repository in which the result was found.
 
-        #: URL to the HTML view of the blob
-        self.html_url = self._get_attribute(data, 'html_url')
+    .. attribute:: score
 
-        #: Repository the code snippet belongs to
-        self.repository = self._class_attribute(
-            data, 'repository', repos.ShortRepository, self
-        )
+        The confidence score assigned to the result.
 
-        #: Score of the result
-        self.score = self._get_attribute(data, 'score')
+    .. attribute:: sha
 
-        #: Text matches
-        self.text_matches = self._get_attribute(data, 'text_matches', [])
+        The SHA1 of the blob in which the code can be found.
+
+    .. attribute:: text_matches
+
+        A list of the text matches in the blob that generated this result.
+
+        .. note::
+
+            To receive these, you must pass ``text_match=True`` to
+            :meth:`~github3.github.GitHub.search_code`.
+    """
+
+    def _update_attributes(self, data):
+        self._api = data['url']
+        self.git_url = data['git_url']
+        self.html_url = data['html_url']
+        self.name = data['name']
+        self.path = data['path']
+        self.repository = repos.ShortRepository(data['repository'], self)
+        self.score = data['score']
+        self.sha = data['sha']
+        self.text_matches = data.get('text_matches', [])
 
     def _repr(self):
         return '<CodeSearchResult [{0}]>'.format(self.path)
diff --git a/github3/search/issue.py b/github3/search/issue.py
@@ -1,25 +1,39 @@
 # -*- coding: utf-8 -*-
+"""Issue search results implementation."""
 from __future__ import unicode_literals
 
 from ..models import GitHubCore
 from ..issues import ShortIssue
 
 
 class IssueSearchResult(GitHubCore):
-    def _update_attributes(self, data):
-        result = data.copy()
+    """A representation of a search result containing an issue.
+
+    This object has the following attributes:
+
+    .. attribute:: issue
+
+        A :class:`~github3.issues.issue.ShortIssue` representing the issue
+        found in this search result.
+
+    .. attribute:: score
 
-        #: Score of the result
-        self.score = self._get_attribute(result, 'score')
-        if 'score' in result:
-            del result['score']
+        The confidence score of this search result.
 
-        #: Text matches
-        self.text_matches = self._get_attribute(result, 'text_matches', [])
-        if 'text_matches' in result:
-            del result['text_matches']
+    .. attribute:: text_matches
 
-        #: Issue object
+        A list of matches in the issue for this search result.
+
+        .. note::
+
+            To receive these, you must pass ``text_match=True`` to
+            :meth:`~github3.github.GitHub.search_issues`.
+    """
+
+    def _update_attributes(self, data):
+        result = data.copy()
+        self.score = result.pop('score')
+        self.text_matches = result.pop('text_matches', [])
         self.issue = ShortIssue(result, self)
 
     def _repr(self):
diff --git a/github3/search/repository.py b/github3/search/repository.py
@@ -1,25 +1,40 @@
 # -*- coding: utf-8 -*-
+"""Repository search results implementation."""
 from __future__ import unicode_literals
 
 from .. import models
 from .. import repos
 
 
 class RepositorySearchResult(models.GitHubCore):
-    def _update_attributes(self, data):
-        result = data.copy()
+    """A representation of a search result containing a repository.
+
+    This object has the following attributes::
+
+    .. attribute:: repository
+
+        A :class:`~github3.repos.repo.ShortRepository` representing the
+        repository found by the search.
+
+    .. attribute:: score
 
-        #: Score of the result
-        self.score = self._get_attribute(result, 'score')
-        if 'score' in result:
-            del result['score']
+        The confidence score of this search result.
 
-        #: Text matches
-        self.text_matches = self._get_attribute(result, 'text_matches', [])
-        if 'text_matches' in result:
-            del result['text_matches']
+    .. attribute:: text_matches
 
-        #: Repository object
+        A list of the text matches in the repository that generated this
+        result.
+
+        .. note::
+
+            To receive these, you must pass ``text_match=True`` to
+            :meth:`~github3.github.GitHub.search_code`.
+    """
+
+    def _update_attributes(self, data):
+        result = data.copy()
+        self.score = result.pop('score')
+        self.text_matches = result.pop('text_matches', [])
         self.repository = repos.ShortRepository(result, self)
 
     def _repr(self):
