fix typos

Author: mr-mixas

HOWTO.md

@@ -55,7 +55,7 @@ and `ndiff = difftool --no-prompt --tool nested_diff` to section `[aliases]`.
 
 Now `ndiff` subcommand available and may be used in the same manner as `diff`.
 
-### How to run tests locally
+## How to run tests locally
 
 ```sh
 # prepare environment

README.md

@@ -40,8 +40,8 @@ $ nested_diff a.json b.json
 ```
 
 ```sh
-$ nested_diff a.json b.json --ofmt json > patch.json
-$ nested_patch a.json patch.json
+nested_diff a.json b.json --ofmt json > patch.json
+nested_patch a.json patch.json
 ```
 
 ## Library usage

nested_diff/cli.py

@@ -33,7 +33,7 @@ class App:
     version = nested_diff.__version__
 
     def __init__(self, args=None):
-        """Initialize appplication.
+        """Initialize application.
 
         Args:
             args: Command line arguments; sys.argv used by default.
@@ -90,30 +90,26 @@ def get_optional_args_parser(self):
             version=f'%(prog)s {self.version}',
             help='print version and exit',
         )
-
         parser.add_argument(
             '--ifmt',
             type=str,
             default=self.default_ifmt,
             choices=sorted(self.supported_ifmts),
             help='input files format; "%(default)s" is used by default',
         )
-
         parser.add_argument(
             '--ifmt-opts',
             metavar='JSON',
             type=str,
             help='input files format options (JSON string)',
         )
-
         parser.add_argument(
             '--ofmt',
             type=str,
             default=self.default_ofmt,
             choices=sorted(self.supported_ofmts),
             help='output files format; "%(default)s" is used by default',
         )
-
         parser.add_argument(
             '--ofmt-opts',
             metavar='JSON',
@@ -156,7 +152,7 @@ def get_dumper(fmt, **kwargs):
 
     @staticmethod
     def guess_fmt(fp, default, ignore_fps=(sys.stdin, sys.stdout, sys.stderr)):
-        """Guess format of a file object according it's extention."""
+        """Guess format of a file object according it's extension."""
         if fp in ignore_fps:
             return default
 
@@ -169,7 +165,7 @@ def guess_fmt(fp, default, ignore_fps=(sys.stdin, sys.stdout, sys.stderr)):
 
     @staticmethod
     def get_loader(fmt, **kwargs):
-        """Create data loader object accordint to passed format.
+        """Create data loader object according to passed format.
 
         Args:
             fmt: Loader format.
@@ -220,11 +216,11 @@ def override_excepthook():
 
         """
 
-        def overrided(*args, **kwargs):
+        def overridden(*args, **kwargs):
             sys.__excepthook__(*args, **kwargs)  # do all the same
             raise SystemExit(127)  # but change exit code
 
-        sys.excepthook = overrided
+        sys.excepthook = overridden
 
     def run(self):
         """App object entry point.
@@ -431,7 +427,7 @@ def decode(self, data):
             for option in self.decoder.options(section):
                 out[section][option] = self.decoder.get(section, option)
 
-            # cleanup (parser accumulates all readed confs)
+            # cleanup (parser accumulates all confs)
             self.decoder.remove_section(section)
 
         return out

nested_diff/diff_tool.py

@@ -115,7 +115,6 @@ def get_optional_args_parser(self):
             help="don't diff arguments, just format and show them; nested "
             'diffs expected for input',
         )
-
         parser.add_argument(
             '--text-ctx',
             default=3,
@@ -124,22 +123,19 @@ def get_optional_args_parser(self):
             help='amount of context lines for text (multiline strings) diffs; '
             'negative value will disable such diffs, default is "%(default)s"',
         )
-
         parser.add_argument(
             '--out',
             default=sys.stdout,
             metavar='FILE',
             type=argparse.FileType('w'),
             help='output file; STDOUT is used if omitted',
         )
-
         parser.add_argument(
             '-q',
             '--quiet',
             action='store_true',
             help="don't show diff, exit code is the only difference indicator",
         )
-
         parser.add_argument(
             '--values',
             choices=('repr', 'none', 'json', 'yaml'),

tests/cli/shared.text.a.json

@@ -1,3 +1,3 @@
 {
-   "text": "Common line,\nanother common line.\nAnd one more common line.\nStill a common line, but last, next will be different.\nFirst string for a.\nSecond striing for a.\nThird string, belongs to file a.\nAnd fourth. Again to a.\nWow! Common strings began! =)\nAnother common line.\nDifferent line. AAaaaaa!!\nAaaaa!!\nA!\n"
+   "text": "Common line,\nanother common line.\nAnd one more common line.\nStill a common line, but last, next will be different.\nFirst string for a.\nSecond string for a.\nThird string, belongs to file a.\nAnd fourth. Again to a.\nWow! Common strings began! =)\nAnother common line.\nDifferent line. AAaaaaa!!\nAaaaa!!\nA!\n"
 }

tests/cli/shared.text.b.json

@@ -1,3 +1,3 @@
 {
-   "text": "Common line,\nanother common line.\nAnd one more common line.\nStill a common line, but last, next will be different.\nFirst string for b.\nSecond striing for b.\nThird string, belongs to file b.\nAnd fourth. Again to b.\nWow! Common strings began! =)\nAnother common line.\nDifferent line. BBbbbbb!!\nBbbbb!!\nB!\n"
+   "text": "Common line,\nanother common line.\nAnd one more common line.\nStill a common line, but last, next will be different.\nFirst string for b.\nSecond string for b.\nThird string, belongs to file b.\nAnd fourth. Again to b.\nWow! Common strings began! =)\nAnother common line.\nDifferent line. BBbbbbb!!\nBbbbb!!\nB!\n"
 }

tests/cli/test_cli.py

@@ -56,7 +56,7 @@ def test_exit_code_wrong_args():
     assert e.value.code == 2
 
 
-def test_excepthook_overrided():
+def test_excepthook_overridden():
     orig_id = id(sys.excepthook)
     cli.App(args=())
 

tests/cli/test_diff_tool.py

@@ -379,15 +379,15 @@ def test_yaml_ofmt(capsys, expected, rpath):
 def test_python_yaml_impl(capsys, expected, rpath):
     orig_import = builtins.__import__
 
-    def overrided_import(name, globals, locals, fromlist, level):  # noqa A002
+    def overridden_import(name, globals, locals, fromlist, level):  # noqa A002
         if name == 'yaml' and fromlist is not None:
             for sym in ('CSafeDumper', 'CSafeLoader'):
                 if sym in fromlist:
                     raise ImportError(f'Mocked import error for yaml.{sym}')
 
         return orig_import(name, globals, locals, fromlist, level)  # noqa A002
 
-    with mock.patch('builtins.__import__', overrided_import):
+    with mock.patch('builtins.__import__', overridden_import):
         exit_code = nested_diff.diff_tool.App(
             args=(
                 rpath('shared.lists.a.yaml'),

tests/cli/test_diff_tool.test_text_context_0.exp

@@ -2,11 +2,11 @@
 #   <str>
     @@ -5,4 +5,4 @@
 -   First string for a.
--   Second striing for a.
+-   Second string for a.
 -   Third string, belongs to file a.
 -   And fourth. Again to a.
 +   First string for b.
-+   Second striing for b.
++   Second string for b.
 +   Third string, belongs to file b.
 +   And fourth. Again to b.
     @@ -11,3 +11,3 @@

tests/cli/test_diff_tool.test_text_default.exp

@@ -5,11 +5,11 @@
     And one more common line.
     Still a common line, but last, next will be different.
 -   First string for a.
--   Second striing for a.
+-   Second string for a.
 -   Third string, belongs to file a.
 -   And fourth. Again to a.
 +   First string for b.
-+   Second striing for b.
++   Second string for b.
 +   Third string, belongs to file b.
 +   And fourth. Again to b.
     Wow! Common strings began! =)