Clarify the type of the 'owner' attribute on Repository objects (sigmavirus24#979)

kpfleming · sigmavirus24 · omgjlk · commit 8bda693ba82f · 2020-01-03T14:02:35.000-08:00
* Clarify the type of the 'owner' attribute on Repository objects

Throughout the github3.py API, 'owner' is generally a string object, but
the 'owner' attribute of Repository objects is not, it's a ShortUser object.
This patch updates the documentation to explicitly indicate that so that
developers won't be surprised by the type of the attribute.

Signed-off-by: Kevin P. Fleming &lt;kpfleming@bloomberg.net&gt;

* Add AUTHORS entry as requested

Signed-off-by: Kevin P. Fleming &lt;kpfleming@bloomberg.net&gt;

Co-authored-by: Ian Stapleton Cordasco &lt;graffatcolmingov@gmail.com&gt;
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -190,3 +190,5 @@ Contributors
 - Erico Fusco (@ericofusco)
 
 - Ben Jefferies (@benjefferies)
+
+- Kevin P. Fleming (@kpfleming)
diff --git a/src/github3/repos/repo.py b/src/github3/repos/repo.py
@@ -3242,7 +3242,8 @@ class ShortRepository(_Repository):
 
     .. attribute:: owner
 
-        The owner of the repository, e.g., ``sigmavirus24``.
+        A :class:`~github3.users.ShortUser` object representing the owner of
+        the repository.
 
     .. attribute:: private
 
