making module docstrings and coding comments consistent

itachi0746 · Jul 19, 2016 · 15a3869 · 15a3869
1 parent 75d72ca
commit 15a3869
Show file tree

Hide file tree

Showing 20 changed files with 29 additions and 16 deletions.
diff --git a/requests/__init__.py b/requests/__init__.py
@@ -38,7 +38,6 @@
 
 :copyright: (c) 2016 by Kenneth Reitz.
 :license: Apache 2.0, see LICENSE for more details.
-
 """
 
 __title__ = 'requests'

diff --git a/requests/api.py b/requests/api.py
@@ -8,7 +8,6 @@
 
 :copyright: (c) 2012 by Kenneth Reitz.
 :license: Apache2, see LICENSE for more details.
-
 """
 
 from . import sessions

diff --git a/requests/certs.py b/requests/certs.py
@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 """
-certs.py
-~~~~~~~~
+requests.certs
+~~~~~~~~~~~~~~
 
 This module returns the preferred default CA certificate bundle.
 

diff --git a/requests/compat.py b/requests/compat.py
@@ -1,7 +1,11 @@
 # -*- coding: utf-8 -*-
 
 """
-pythoncompat
+requests.compat
+~~~~~~~~~~~~~~~
+
+This module handles import compatibility issues between Python 2 and
+Python 3.
 """
 
 from .packages import chardet

diff --git a/requests/cookies.py b/requests/cookies.py
@@ -1,6 +1,9 @@
 # -*- coding: utf-8 -*-
 
 """
+requests.cookies
+~~~~~~~~~~~~~~~~
+
 Compatibility code to be able to use `cookielib.CookieJar` with requests.
 
 requests.utils imports from here, so be careful with imports.

diff --git a/requests/exceptions.py b/requests/exceptions.py
@@ -5,7 +5,6 @@
 ~~~~~~~~~~~~~~~~~~~
 
 This module contains the set of Requests' exceptions.
-
 """
 from .packages.urllib3.exceptions import HTTPError as BaseHTTPError
 

diff --git a/requests/hooks.py b/requests/hooks.py
@@ -10,7 +10,6 @@
 
 ``response``:
     The response generated from a Request.
-
 """
 HOOKS = ['response']
 

diff --git a/requests/sessions.py b/requests/sessions.py
@@ -6,7 +6,6 @@
 
 This module provides a Session object to manage and persist settings across
 requests (cookies, auth, proxies).
-
 """
 import os
 from collections import Mapping

diff --git a/requests/structures.py b/requests/structures.py
@@ -5,7 +5,6 @@
 ~~~~~~~~~~~~~~~~~~~
 
 Data structures that power Requests.
-
 """
 
 import collections

diff --git a/requests/utils.py b/requests/utils.py
@@ -6,7 +6,6 @@
 
 This module provides utility functions that are used within Requests
 that are also useful for external consumption.
-
 """
 
 import cgi

diff --git a/tests/__init__.py b/tests/__init__.py
@@ -1,4 +1,4 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
 
 """Requests test package initialisation."""
 

diff --git a/tests/compat.py b/tests/compat.py
@@ -1,4 +1,5 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
+
 from requests.compat import is_py3
 
 

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,4 +1,5 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
+
 import pytest
 from requests.compat import urljoin
 

diff --git a/tests/test_hooks.py b/tests/test_hooks.py
@@ -1,4 +1,5 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
+
 import pytest
 
 from requests import hooks

diff --git a/tests/test_lowlevel.py b/tests/test_lowlevel.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import os
 import pytest
 import threading

diff --git a/tests/test_structures.py b/tests/test_structures.py
@@ -1,4 +1,5 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
+
 import pytest
 
 from requests.structures import CaseInsensitiveDict, LookupDict

diff --git a/tests/test_testserver.py b/tests/test_testserver.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import threading
 import socket
 import time

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -1,4 +1,5 @@
-# coding: utf-8
+# -*- coding: utf-8 -*-
+
 from io import BytesIO
 
 import pytest

diff --git a/tests/testserver/server.py b/tests/testserver/server.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import threading
 import socket
 import select

diff --git a/tests/utils.py b/tests/utils.py
@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 import contextlib
 import os
-Original file line number
+Diff line change
@@ Expand Up / @@ -38,7 +38,6 @@ @@
     :copyright: (c) 2016 by Kenneth Reitz.
     :license: Apache 2.0, see LICENSE for more details.
     """
     __title__ = 'requests'
@@ Expand Down @@