minor cleanup

Author: andhus

README.md

@@ -2,11 +2,10 @@
 [![codecov](https://codecov.io/gh/andhus/dirhash-python/branch/master/graph/badge.svg)](https://codecov.io/gh/andhus/dirhash-python)
 
 # dirhash
-A lightweight python module and tool for computing the hash of any
+A lightweight python module and CLI for computing the hash of any
 directory based on its files' structure and content.
-- Supports any hashing algorithm of Python's built-in `hashlib` module
-- `.gitignore` style "wildmatch" patterns for expressive filtering of files to 
-include/exclude.
+- Supports all hashing algorithms of Python's built-in `hashlib` module.
+- Glob/wildcard (".gitignore style") path matching for expressive filtering of files to include/exclude.
 - Multiprocessing for up to [6x speed-up](#performance)
 
 The hash is computed according to the [Dirhash Standard](https://github.com/andhus/dirhash), which is designed to allow for consistent and collision resistant generation/verification of directory hashes across implementations.
@@ -68,7 +67,7 @@ and executing `hashlib` code.
 The main effort to boost performance is support for multiprocessing, where the
 reading and hashing is parallelized over individual files.
 
-As a reference, let's compare the performance of the `dirhash` [CLI](https://github.com/andhus/dirhash/dirhash-python/cli.py) 
+As a reference, let's compare the performance of the `dirhash` [CLI](https://github.com/andhus/dirhash-python/cli.py) 
 with the shell command:
 
 `find path/to/folder -type f -print0 | sort -z | xargs -0 md5 | md5` 

src/dirhash/__init__.py

@@ -105,14 +105,14 @@ def dirhash(
     # Path Selection and Filtering
         Provided glob/wildcard (".gitignore style") match-patterns determine what
         paths within the `directory` to include when computing the hash value. Paths
-        *relative to the root `directory` (i.e. excluding the name of the directory
-        itself) are matched against the patterns.
+        *relative to the root `directory`* (i.e. excluding the name of the root
+        directory itself) are matched against the patterns.
             The `match` argument represent what should be *included* - as opposed
-        to `ignore` patterns for which matches are *excluded*. Using `ignore` is
+        to the `ignore` argument for which matches are *excluded*. Using `ignore` is
         just short for adding the same patterns to the `match` argument with the
         prefix "!", i.e. the calls bellow are equivalent:
-            `dirhash(..., match=['*', '!<pattern>'])`
-            `dirhash(..., ignore=['<pattern>'])`
+            `dirhash(..., match=["*", "!<pattern>"])`
+            `dirhash(..., ignore=["<pattern>"])`
         To validate which paths are included, call `dirhash.included_paths` with
         the same values for the arguments: `match`, `ignore`, `linked_dirs`,
         `linked_files` and `empty_dirs` to get a list of all paths that will be
@@ -348,7 +348,7 @@ class Filter(RecursionFilter):
     # Arguments
         match: Iterable[str] - An iterable of glob/wildcard (".gitignore style")
             match patterns for selection of which files and directories to include.
-            Paths *relative to the root `directory` (i.e. excluding the name of the
+            Paths *relative to the root `directory`* (i.e. excluding the name of the
             root directory itself) are matched against the provided patterns. For
             example, to include all files, except for hidden ones use:
             `match=['*', '!.*']` Default `None` which is equivalent to `['*']`,

src/dirhash/cli.py

@@ -43,10 +43,11 @@ def get_kwargs(args):
         choices=dirhash.algorithms_available,
         default='md5',
         help=(
-            'Hashing algorithm to use. Always available: {}. Additionally available '
-            'on current platform: {}. Note that the same algorithm may appear '
-            'multiple times in this set under different names (thanks to '
-            'OpenSSL) [https://docs.python.org/2/library/hashlib.html]'.format(
+            'Hashing algorithm to use, by default "md5". Always available: {}. '
+            'Additionally available on current platform: {}. Note that the same '
+            'algorithm may appear multiple times in this set under different names '
+            '(thanks to OpenSSL) '
+            '[https://docs.python.org/2/library/hashlib.html]'.format(
                 sorted(dirhash.algorithms_guaranteed),
                 sorted(dirhash.algorithms_available - dirhash.algorithms_guaranteed)
             )
@@ -77,7 +78,7 @@ def get_kwargs(args):
         nargs='+',
         default=['*'],
         help=(
-            'String of match-patterns, separated by blank space. NOTE: patterns '
+            'One or several patterns for paths to include. NOTE: patterns '
             'with an asterisk must be in quotes ("*") or the asterisk '
             'preceded by an escape character (\*).'
         ),
@@ -88,7 +89,7 @@ def get_kwargs(args):
         nargs='+',
         default=None,
         help=(
-            'String of ignore-patterns, separated by blank space. NOTE: patterns '
+            'One or several patterns for paths to exclude. NOTE: patterns '
             'with an asterisk must be in quotes ("*") or the asterisk '
             'preceded by an escape character (\*).'
         ),
@@ -175,27 +176,5 @@ def get_kwargs(args):
     return vars(parser.parse_args(args))
 
 
-# def preprocess_kwargs(kwargs):
-#     match_kwargs = {}
-#     for kwarg in ['match', 'ignore']:
-#         match_kwargs[kwarg] = kwargs.pop(kwarg)
-#     match_patterns = dirhash.get_match_patterns(**match_kwargs)
-#
-#     filtering_kwargs = {
-#         'match': match_patterns,
-#         'linked_dirs': kwargs.pop('linked_dirs'),
-#         'linked_files': kwargs.pop('linked_files'),
-#         'empty_dirs': kwargs.pop('empty_dirs'),
-#     }
-#     protocol_kwargs = {
-#         'allow_cyclic_links': kwargs.pop('allow_cyclic_links'),
-#         'entry_properties': kwargs.pop('properties') or ["data", "name"]
-#     }
-#     kwargs['filtering'] = filtering_kwargs
-#     kwargs['protocol'] = protocol_kwargs
-#
-#     return kwargs
-
-
 if __name__ == '__main__':  # pragma: no cover
     main()