Re-enable pylint missing-module-docstring check

pylintrc

@@ -21,5 +21,4 @@ score=yes
 
 [MESSAGES CONTROL]
 disable=
- missing-module-docstring,
  missing-function-docstring,

searchkit/__init__.py

@@ -1,3 +1,4 @@
+""" Searchkit interface. """
 from .search import (
     FileSearcher,
     ResultFieldInfo,

searchkit/constraints.py

@@ -1,3 +1,9 @@
+""" Search constraints module.
+
+Searchkit searches are by default unbound in that they will apply to every line
+in a file or files. This may sometimes be inefficient or undesired and can be
+controlled using one of the constraints implementations provided here.
+"""
 import abc
 import re
 import uuid

searchkit/exception.py

@@ -1,3 +1,6 @@
+""" Searchkit exceptions. """
+
+
 class FileSearchException(Exception):
     """ Exception raised when an error occurs during a file search. """
     def __init__(self, msg):

searchkit/log.py

@@ -1,4 +1,4 @@
-#!/usr/bin/python3
+""" Searchkit logging. """
 import logging
 
 log = logging.getLogger('searchkit')

searchkit/result.py

@@ -1,3 +1,4 @@
+""" Search result handlers. """
 import abc
 from functools import cached_property
 from collections import UserList, UserDict

searchkit/search.py

@@ -1,3 +1,10 @@
+""" Search implementations.
+
+Searchkit supports searching one or more file in parallel using multiple
+processes to perform the searches and then collecting their results.
+
+Searches can be single or multi-line.
+"""
 import abc
 import concurrent.futures
 import copy

searchkit/searchdef.py

@@ -1,3 +1,4 @@
+""" Search definitions implementations. """
 import re
 import uuid
 from functools import cached_property

searchkit/task.py

@@ -1,3 +1,4 @@
+""" Search task implementations. """
 import gzip
 import multiprocessing
 import os

searchkit/utils.py

@@ -1,3 +1,4 @@
+""" Search utilities. """
 import abc
 import dbm
 import os

setup.py

@@ -1,3 +1,4 @@
+""" Searchkit package. """
 from setuptools import setup
 
 setup(name='searchkit')

tests/unit/test_search.py

@@ -1,3 +1,4 @@
+""" Searchkit unit tests. """
 import glob
 import os
 import re

tests/unit/test_search_constraints.py

@@ -1,3 +1,4 @@
+""" Searchkit search constraints unit tests. """
 import os
 import re
 import tempfile

tests/unit/test_utils.py

@@ -1,3 +1,4 @@
+""" Searchkit utilities unit tests. """
 import os
 import tempfile
 

tests/unit/utils.py

@@ -1,3 +1,4 @@
+""" Searchkit unit tests utilities. """
 import os
 import unittest