chore: Spelling.

Signed-off-by: Jos Verlinde <Jos.Verlinde@microsoft.com>
Josverl · Jul 26, 2024 · b200f47 · b200f47
1 parent f435f70
commit b200f47
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 45 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -8,42 +8,7 @@
     "peacock.color": "#9b5f28",
     "peacock.remoteColor": "#e2b991",
     "cSpell.words": [
-        "aivar",
-        "annamaa",
-        "braden",
-        "chdir",
-        "cpython",
-        "createstubs",
-        "dastultz",
-        "fname",
-        "fwid",
-        "josverl",
-        "loboris",
-        "markdownlint",
-        "mklink",
-        "mpls",
-        "mystubs",
-        "pfalcon",
-        "pybd",
-        "pyboard",
-        "pybricks",
-        "pylintrc",
-        "pyright",
-        "pytest",
-        "pytests",
-        "Stubber",
-        "stubfiles",
-        "stubgen",
-        "stuborder",
-        "sysname",
-        "testrepo",
-        "thonny",
-        "tinypico",
-        "typeshed",
-        "ulab",
-        "unstubbables",
-        "upysh",
-        "webrepl"
+
     ],
     "terminal.integrated.persistentSessionReviveProcess": "never",
     "workbench.colorCustomizations": {

diff --git a/cspell.json b/cspell.json
@@ -19,9 +19,14 @@
         "adcs",
         "adcx",
         "adcy",
+        "AIOESP",
+        "aiter",
         "aivar",
+        "asend",
+        "atten",
         "Autoflake",
         "basicgit",
+        "baudrate",
         "boardname",
         "boardstubs",
         "braden",
@@ -31,21 +36,37 @@
         "capsys",
         "chdir",
         "codemod",
+        "configtuple",
         "cpython",
         "createstubs",
+        "currentmodule",
         "dastultz",
+        "deadtime",
         "Decomp",
+        "deepsleep",
+        "dequeu",
         "descr",
+        "docpages",
+        "docstr",
+        "docstream",
         "docstrings",
         "docstub",
         "docstubs",
+        "espnow",
+        "extframe",
+        "firstbit",
         "fname",
+        "framebuffer",
+        "fsobj",
         "fwid",
+        "hclk",
         "imphook",
         "IPPROTO",
         "josverl",
         "jsondb",
+        "keepends",
         "libcst",
+        "linecounter",
         "loboris",
         "loguru",
         "markdownlint",
@@ -54,37 +75,93 @@
         "micropython",
         "mklink",
         "modulelist",
+        "mpflash",
         "mpls",
         "mpremote",
         "mystubs",
         "noindex",
+        "oneliner",
+        "onewire",
         "pathnames",
+        "pclk",
         "pfalcon",
+        "prescaler",
         "pybricks",
         "pylintrc",
         "pyright",
         "pytest",
         "pytestmark",
         "pytests",
+        "readbit",
+        "readblock",
+        "readbyte",
         "reqs",
         "serialport",
+        "setfiler",
+        "setfilter",
+        "sourcecode",
         "sourcery",
         "strerror",
         "stubfiles",
         "stubfolder",
         "stubgen",
         "stuborder",
+        "sysclk",
         "testrepo",
+        "textblock",
         "thonny",
         "tinypico",
         "toctree",
         "typeshed",
+        "UART",
         "updent",
+        "uselect",
         "Verlinde",
+        "WIZNET",
         "worklist",
-        "writeln"
+        "writebit",
+        "writeblocks",
+        "writebyte",
+        "writeln",
+        "aivar",
+        "annamaa",
+        "braden",
+        "chdir",
+        "cpython",
+        "createstubs",
+        "dastultz",
+        "fname",
+        "fwid",
+        "josverl",
+        "loboris",
+        "markdownlint",
+        "mklink",
+        "mpls",
+        "mystubs",
+        "pfalcon",
+        "pybd",
+        "pyboard",
+        "pybricks",
+        "pylintrc",
+        "pyright",
+        "pytest",
+        "pytests",
+        "stopwords",
+        "Stubber",
+        "stubfiles",
+        "stubgen",
+        "stuborder",
+        "sysname",
+        "testrepo",
+        "thonny",
+        "tinypico",
+        "typeshed",
+        "ulab",
+        "unstubbables",
+        "upysh",
+        "webrepl"
     ],
     "enableFiletypes": [
         "!plaintext"
     ]
-}
+}
diff --git a/src/stubber/rst/lookup.py b/src/stubber/rst/lookup.py
@@ -18,7 +18,7 @@
     "U_MODULES",
 ]
 
-# all possible Types needed for the stubs - exxess types should be removed later , and otherwise won't do much harm
+# all possible Types needed for the stubs - excess types should be removed later , and otherwise won't do much harm
 TYPING_IMPORT: List[str] = [
     "from __future__ import annotations",
     "from typing import IO, Any, Callable, Coroutine, Dict, Generator, Iterator, List, NoReturn, Optional, Tuple, Union, NamedTuple, TypeVar",
@@ -288,7 +288,7 @@ class Fix:
     # pyb.hid((buttons, x, y, z))
     Fix(
         "(buttons, x, y, z)",
-        "hidtuple:Tuple",
+        "hid_tuple:Tuple",
     ),
     # esp v1.15.2 .. function:: getaddrinfo((hostname, port, lambda))
     Fix(
@@ -502,16 +502,16 @@ class Fix:
     "Switch": "Pin",
     "Signal": "Pin",
     # uio # unclear regarding deprecation in python 3.12
-    # "IOBase": "IO",  # DOCME  not in documentation
+    # "IOBase": "IO",  # DOC_ME  not in documentation
     "TextIOWrapper": "IO",  # "TextIOBase, TextIO",  # based on Stdlib
     "FileIO": "IO",  #  "RawIOBase, BinaryIO",  # based on Stdlib
     "StringIO": "IO",  #  "BufferedIOBase, BinaryIO",  # based on Stdlib
     "BytesIO": "IO",  # "BufferedIOBase, BinaryIO",  # based on Stdlib
-    "BufferedWriter": "IOBase",  # DOCME: not in documentation #   "BufferedWriter": "BufferedIOBase",  # based on Stdlib
+    "BufferedWriter": "IOBase",  # DOC_ME: not in documentation #   "BufferedWriter": "BufferedIOBase",  # based on Stdlib
     # uzlib
     # "DecompIO": "IO",  # https://docs.python.org/3/library/typing.html#other-concrete-types
     # -------------------------------------------------------------------------------------
-    # network - AbstractNIC is definined in docstub network.pyi , but not actually used
+    # network - AbstractNIC is defined in docstub network.pyi , but not actually used
     # "WLAN": "AbstractNIC",
     # "WLANWiPy": "AbstractNIC",
     # "CC3K": "AbstractNIC",
@@ -536,9 +536,9 @@ class Fix:
 
 
 # TODO : implement the execution of this list during merge
-#  - this is a list of functions, classes methods and constantsn  that are not detected at runtime, but are avaialble and documented
+#  - this is a list of functions, classes methods and constants  that are not detected at runtime, but are available and documented
 # the standard merge only adds documentation to detected functions.
-FORCE_NON_DETECED = [
+FORCE_NON_DETECTED = [
     ("btree", "Btree", ["esp32", "esp8266"]),  # Is not detected runtime
     ("espnow", "ESPNow.peers_table", ["esp32"]),  # Is not detected runtime
 ]