From e174a45562250bb56e064fad33fa1e9d5f014d01 Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Thu, 5 Aug 2021 06:49:12 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - src/conf.py - src/correctness/no_exception_type_specified.rst - src/django/1.8/migration/index.rst - src/django/all/security/index.rst - src/performance/not_using_iteritems_to_iterate_large_dict.rst - src/readability/not_using_a_dict_comprehension.rst - src/readability/not_using_dict_keys_when_formatting_strings.rst - src/readability/putting_type_information_in_a_variable_name.rst Fixes: - Should read `reduce` rather than `recude`. - Should read `proprietary` rather than `proprietory`. - Should read `preferred` rather than `prefered`. - Should read `paths` rather than `pathes`. - Should read `package` rather than `packafe`. - Should read `occurred` rather than `occured`. - Should read `modified` rather than `modifed`. - Should read `installs` rather than `installes`. - Should read `explicitly` rather than `explicity`. - Should read `comprehension` rather than `comprehesion`. --- src/conf.py | 2 +- src/correctness/no_exception_type_specified.rst | 6 +++--- src/django/1.8/migration/index.rst | 2 +- src/django/all/security/index.rst | 2 +- .../not_using_iteritems_to_iterate_large_dict.rst | 2 +- src/readability/not_using_a_dict_comprehension.rst | 2 +- .../not_using_dict_keys_when_formatting_strings.rst | 2 +- .../putting_type_information_in_a_variable_name.rst | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/conf.py b/src/conf.py index 23b8305..a6018c4 100644 --- a/src/conf.py +++ b/src/conf.py @@ -189,7 +189,7 @@ #'papersize': 'letterpaper', # Set font package -# linux libertine needs this packafe installes on the machine +# linux libertine needs this package installs on the machine # https://www.ctan.org/tex-archive/fonts/libertine/?lang=de # but should also be in the full installation of tex-live "fontpkg" : """ diff --git a/src/correctness/no_exception_type_specified.rst b/src/correctness/no_exception_type_specified.rst index 121b3e7..bf56d16 100644 --- a/src/correctness/no_exception_type_specified.rst +++ b/src/correctness/no_exception_type_specified.rst @@ -37,9 +37,9 @@ Handle exceptions with Python's built in `exception types `_ +- `Stack Overflow - Create a dictionary with list comprehension `_ diff --git a/src/readability/not_using_dict_keys_when_formatting_strings.rst b/src/readability/not_using_dict_keys_when_formatting_strings.rst index 4337f0a..f583c23 100644 --- a/src/readability/not_using_dict_keys_when_formatting_strings.rst +++ b/src/readability/not_using_dict_keys_when_formatting_strings.rst @@ -1,7 +1,7 @@ Not using dict keys when formatting strings =========================================== -When formatting a string with values from a dictionary, you can use the dictionary keys instead of explicity defining all of the format parameters. Consider this dictionary that stores the name and age of a person. +When formatting a string with values from a dictionary, you can use the dictionary keys instead of explicitly defining all of the format parameters. Consider this dictionary that stores the name and age of a person. .. code:: python diff --git a/src/readability/putting_type_information_in_a_variable_name.rst b/src/readability/putting_type_information_in_a_variable_name.rst index e2cafa2..3464d51 100644 --- a/src/readability/putting_type_information_in_a_variable_name.rst +++ b/src/readability/putting_type_information_in_a_variable_name.rst @@ -22,7 +22,7 @@ Best practice Remove type notation .................... -Although the modifed code below does not fix the underlying problem of attempting to divide a number by a string, the code is generally less misleading, because there is no misleading description in the variable name ``n`` that ``n`` is a number. +Although the modified code below does not fix the underlying problem of attempting to divide a number by a string, the code is generally less misleading, because there is no misleading description in the variable name ``n`` that ``n`` is a number. .. code:: python