Added decorator for calls that change when authenticated.

JNRowe · JNRowe · commit 1cc735c3f9e4 · 2011-05-05T06:08:33.000+01:00
diff --git a/doc/api/core.rst b/doc/api/core.rst
@@ -15,6 +15,7 @@ Core
 .. autofunction:: datetime_to_commitdate
 
 .. autofunction:: requires_auth
+.. autofunction:: enhanced_by_auth
 
 .. autofunction:: doc_generator
 
diff --git a/github2/core.py b/github2/core.py
@@ -68,6 +68,19 @@ def wrapper(self, *args, **kwargs):
     return wrapped
 
 
+def enhanced_by_auth(f):
+    """Decorator to mark a function as enhanced by authentication
+
+    Sets a ``enhanced_by_auth`` attribute on functions, for use in
+    introspection.
+
+    :param func f: Function to wrap
+    """
+    f.enhanced_by_auth = True
+    f.__doc__ += """\n.. note:: This call is enhanced with authentication"""
+    return f
+
+
 class GithubCommand(object):
 
     def __init__(self, request):
