Skip to content

Commit 5193608

Browse files
pylint: fix missing-module-docstring cases
Fix all cases of C0114 missing-module-docstring. Part of #270
1 parent e109787 commit 5193608

30 files changed

+129
-10
lines changed

docs/source/conf.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Tarantool python client library documentation build configuration file, created by
2-
# sphinx-quickstart on Tue Nov 29 06:29:57 2011.
3-
#
4-
# This file is execfile()d with the current directory set to its containing dir.
5-
#
6-
# Note that not all possible configuration values are present in this
7-
# autogenerated file.
8-
#
9-
# All configuration values have a default; values that are commented out
10-
# serve to show the default.
1+
"""
2+
Tarantool python client library documentation build configuration file, created by
3+
sphinx-quickstart on Tue Nov 29 06:29:57 2011.
4+
5+
This file is execfile()d with the current directory set to its containing dir.
6+
7+
Note that not all possible configuration values are present in this
8+
autogenerated file.
9+
10+
All configuration values have a default; values that are commented out
11+
serve to show the default.
12+
"""
1113
# pylint: disable=invalid-name
1214

1315
import sys, os

setup.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
#!/usr/bin/env python
2+
"""
3+
Package setup commands.
4+
"""
25

36
import codecs
47
import os

tarantool/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This package provides API for interaction with a Tarantool server.
3+
"""
4+
15
import sys
26

37
from tarantool.connection import Connection

tarantool/const.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module a set of constants for the package.
3+
"""
4+
15
IPROTO_REQUEST_TYPE = 0x00
26
IPROTO_SYNC = 0x01
37
# replication keys (header)

tarantool/utils.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module provides untility functions for the package.
3+
"""
4+
15
from base64 import decodebytes as base64_decode
26
import sys
37
import uuid

test/setup_command.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
#!/usr/bin/env python
2+
"""
3+
This module describes class implementing `python setup.py test`.
4+
"""
25

36
import os
47
import sys

test/suites/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
Module tests entrypoint.
3+
"""
4+
15
import os
26
import unittest
37

test/suites/lib/remote_tarantool_server.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
"""
2+
This module provides helpers to work with remote Tarantool server
3+
(used on Windows).
4+
"""
5+
16
import sys
27
import os
38
import random

test/suites/lib/skip.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module provides helpers to skip specific tests.
3+
"""
4+
15
import functools
26
import re
37
import sys

test/suites/lib/tarantool_admin.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module provides helpers to setup running Tarantool server.
3+
"""
4+
15
import socket
26
import re
37

test/suites/lib/tarantool_server.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module provides helpers start up a Tarantool server.
3+
"""
4+
15
import os
26
import os.path
37
import errno

test/suites/test_connection.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests basic connection behavior.
3+
"""
4+
15
import sys
26
import unittest
37

test/suites/test_crud.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests integration with tarantool/crud.
3+
"""
4+
15
import re
26
import sys
37
import time

test/suites/test_datetime.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with datetime type.
3+
"""
4+
15
import sys
26
import re
37
import unittest

test/suites/test_dbapi.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests compatibility with DBAPI standards.
3+
"""
4+
15
import sys
26
import unittest
37

test/suites/test_decimal.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with decimal type.
3+
"""
4+
15
import sys
26
import unittest
37
import decimal

test/suites/test_dml.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests basic data operations.
3+
"""
4+
15
import sys
26
import unittest
37
import tarantool

test/suites/test_encoding.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests various type encoding cases.
3+
"""
4+
15
import sys
26
import unittest
37

test/suites/test_error_ext.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with extended error type.
3+
"""
4+
15
import sys
26
import unittest
37
import uuid

test/suites/test_execute.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests API fo execute SQL on a server.
3+
"""
4+
15
import sys
26
import unittest
37

test/suites/test_interval.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with datetime interval type.
3+
"""
4+
15
import re
26
import sys
37
import unittest

test/suites/test_mesh.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
"""
2+
This module tests work with a cluster of Tarantool servers through
3+
MeshConnection.
4+
"""
5+
16
import sys
27
import unittest
38
import warnings

test/suites/test_package.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests package features.
3+
"""
4+
15
import os
26
import sys
37
import unittest

test/suites/test_pool.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
"""
2+
This module tests work with a cluster of Tarantool servers through
3+
ConnectionPool.
4+
"""
5+
16
import sys
27
import time
38
import unittest

test/suites/test_protocol.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests connection authentication.
3+
"""
4+
15
import sys
26
import unittest
37
import uuid

test/suites/test_push.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with IPROTO pushed messages.
3+
"""
4+
15
import sys
26
import unittest
37
import tarantool

test/suites/test_reconnect.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests basic reconnect behavior.
3+
"""
4+
15
import sys
26
import unittest
37
import warnings

test/suites/test_schema.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests space and index schema fetch.
3+
"""
4+
15
import sys
26
import unittest
37
import pkg_resources

test/suites/test_ssl.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests connection through SSL.
3+
"""
4+
15
import os
26
import sys
37
import unittest

test/suites/test_uuid.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
"""
2+
This module tests work with UUID type.
3+
"""
4+
15
import sys
26
import unittest
37
import uuid

0 commit comments

Comments
 (0)