Merge pull request #160 from dropbox/rob/fix_async_docs

risforrob · web-flow · commit 0f26ac377218 · 2018-12-21T20:26:18.000-08:00
fix async docs
diff --git a/.gitignore b/.gitignore
@@ -12,3 +12,4 @@ __pycache__/
 *.pyc
 *.pyo
 *~
+.venv
diff --git a/.pylintrc b/.pylintrc
@@ -1,5 +1,5 @@
 [MESSAGES CONTROL]
-disable=C,R,file-ignored,fixme,locally-disabled,protected-access,useless-else-on-loop
+disable=C,R,file-ignored,fixme,locally-disabled,protected-access,useless-else-on-loop,unnecessary-pass
 enable=useless-suppression
 
 [REPORTS]
diff --git a/docs/api/async.rst b/docs/api/async.rst
@@ -1,6 +1,8 @@
-:mod:`dropbox.async` -- Async
-============================================
-.. automodule:: dropbox.async
+:mod:`dropbox.async_` -- Async
+==============================
+   *As of Python 3.5,* ``async`` *is a reserved keyword.  For versions of Python prior to 3.5, the objects documented can be imported from either* ``dropbox.async`` *or* ``dropbox.async_``.  *For Python 3.5+, only* ``dropbox.async_`` *is supported.*
+
+.. automodule:: dropbox.async_
    :members:
    :show-inheritance:
    :special-members: __init__
diff --git a/docs/api/auth.rst b/docs/api/auth.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.auth` -- Auth
-============================================
+===========================
 .. automodule:: dropbox.auth
    :members:
    :show-inheritance:
diff --git a/docs/api/common.rst b/docs/api/common.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.common` -- Common
-============================================
+===============================
 .. automodule:: dropbox.common
    :members:
    :show-inheritance:
diff --git a/docs/api/contacts.rst b/docs/api/contacts.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.contacts` -- Contacts
-============================================
+===================================
 .. automodule:: dropbox.contacts
    :members:
    :show-inheritance:
diff --git a/docs/api/dropbox.rst b/docs/api/dropbox.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.dropbox` -- Dropbox
-============================================
+=================================
 .. automodule:: dropbox.dropbox
    :members:
    :show-inheritance:
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.exceptions` -- Exceptions
-============================================
+=======================================
 .. automodule:: dropbox.exceptions
    :members:
    :show-inheritance:
diff --git a/docs/api/file_properties.rst b/docs/api/file_properties.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.file_properties` -- File Properties
-============================================
+=================================================
 .. automodule:: dropbox.file_properties
    :members:
    :show-inheritance:
diff --git a/docs/api/file_requests.rst b/docs/api/file_requests.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.file_requests` -- File Requests
-============================================
+=============================================
 .. automodule:: dropbox.file_requests
    :members:
    :show-inheritance:
diff --git a/docs/api/files.rst b/docs/api/files.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.files` -- Files
-============================================
+=============================
 .. automodule:: dropbox.files
    :members:
    :show-inheritance:
diff --git a/docs/api/index.rst b/docs/api/index.rst
diff --git a/docs/api/oauth.rst b/docs/api/oauth.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.oauth` -- OAuth
-============================================
+=============================
 .. automodule:: dropbox.oauth
    :members:
    :show-inheritance:
diff --git a/docs/api/paper.rst b/docs/api/paper.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.paper` -- Paper
-============================================
+=============================
 .. automodule:: dropbox.paper
    :members:
    :show-inheritance:
diff --git a/docs/api/seen_state.rst b/docs/api/seen_state.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.seen_state` -- Seen State
-============================================
+=======================================
 .. automodule:: dropbox.seen_state
    :members:
    :show-inheritance:
diff --git a/docs/api/sharing.rst b/docs/api/sharing.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.sharing` -- Sharing
-============================================
+=================================
 .. automodule:: dropbox.sharing
   :members:
   :show-inheritance:
diff --git a/docs/api/team.rst b/docs/api/team.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.team` -- Team
-============================================
+===========================
 .. automodule:: dropbox.team
    :members:
    :show-inheritance:
diff --git a/docs/api/team_common.rst b/docs/api/team_common.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.team_common` -- Team Common
-============================================
+=========================================
 .. automodule:: dropbox.team_common
    :members:
    :show-inheritance:
diff --git a/docs/api/team_log.rst b/docs/api/team_log.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.team_log` -- Team Log
-============================================
+===================================
 .. automodule:: dropbox.team_log
    :members:
    :show-inheritance:
diff --git a/docs/api/team_policies.rst b/docs/api/team_policies.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.team_policies` -- Team Policies
-============================================
+=============================================
 .. automodule:: dropbox.team_policies
    :members:
    :show-inheritance:
diff --git a/docs/api/users.rst b/docs/api/users.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.users` -- Users
-============================================
+=============================
 .. automodule:: dropbox.users
    :members:
    :show-inheritance:
diff --git a/docs/api/users_common.rst b/docs/api/users_common.rst
@@ -1,5 +1,5 @@
 :mod:`dropbox.users_common` -- Users Common
-============================================
+===========================================
 .. automodule:: dropbox.users_common
    :members:
    :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,7 +54,7 @@
 
 # General information about the project.
 project = u'Dropbox for Python'
-copyright = u'2015-2017, Dropbox, Inc.'
+copyright = u'2015-2019, Dropbox, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
diff --git a/example/back-up-and-restore/backup-and-restore-example.py b/example/back-up-and-restore/backup-and-restore-example.py
@@ -81,7 +81,7 @@ def select_revision():
     # Check that the access token is valid
     try:
         dbx.users_get_current_account()
-    except AuthError as err:
+    except AuthError:
         sys.exit("ERROR: Invalid access token; try re-generating an "
             "access token from the app console on the web.")
 
diff --git a/tox.ini b/tox.ini
@@ -16,7 +16,7 @@ pypy3 = lint
 [flake8]
 
 # See <https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes>
-ignore = E128,E301,E302,E305,E402,W503
+ignore = E128,E301,E302,E305,E402,W503,W504
 max-line-length = 100
 
 

-Original file line number
+Diff line change
 *.pyc
 *.pyo
 *~
 +.venv