Fix typos, unknown utf8-chars, and capitalize GitHub in docs (#2495)

Avasam · web-flow · commit cfd3d861f42e · 2025-06-16T04:19:04.000-04:00
diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md
@@ -1,6 +1,6 @@
 ---
 name: New issue
-about: Do not open github issues for general support requests
+about: Do not open GitHub issues for general support requests
 ---
 
 <!--
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -28,7 +28,7 @@ Coming in build 311, as yet unreleased
 Build 310, released 2025/03/16
 ------------------------------
 * Fixed a regression where `win32com.client.DispatchWithEvents` and win32com.client.WithEvents` would throw a `TypeError` on the second call (#2491, @Avasam)
-* Fixed regresion causing `win32com.shell.shell` to be missing a number of `IID`s. (#2487, @Avasam)
+* Fixed regression causing `win32com.shell.shell` to be missing a number of `IID`s. (#2487, @Avasam)
 * As part of the above, Windows 7 is now minimum supported.
 
 Build 309, released 2025/03/09
@@ -357,7 +357,7 @@ Build 302, released 2021-10-11
   import win2kras and it fails with 'you must import win32ras first', then it
   means an old win2kras.pyd exists, which you should remove.
 
-* github branch 'master' was renamed to 'main'.
+* GitHub branch 'master' was renamed to 'main'.
 
 Build 301, released 2021-05-30
 ------------------------------
diff --git a/Pythonwin/Scintilla/README_pythonwin.md b/Pythonwin/Scintilla/README_pythonwin.md
@@ -1,11 +1,11 @@
 This is a copy of Scintilla 4.4.6 used for Pythonwin.
 
-Scintilla's home is https://www.scintilla.org/
+Scintilla's home is <https://www.scintilla.org/>
 
 Only the sources relevant to Scintilla under Pythonwin are
-included (plus the Scintilla Licence.txt and README).
+included (plus the Scintilla `License.txt` and `README`).
 For the full set of Scintilla sources, including its documentation
-and companion editor SciTE, see https://www.scintilla.org/ .
+and companion editor SciTE, see <https://www.scintilla.org/>.
 
 When updating the Scintilla source, also update the copyright year
 in Pythonwin/pywin/framework/app.py and regenerate
diff --git a/Pythonwin/Scintilla/lexers/LexBaan.cxx b/Pythonwin/Scintilla/lexers/LexBaan.cxx
@@ -906,7 +906,7 @@ void SCI_METHOD LexerBaan::Fold(Sci_PositionU startPos, Sci_Position length, int
 		// Section Foldings.
 		// One way of implementing Section Foldings, as there is no END markings of sections.
 		// first section ends on the previous line of next section.
-		// Re-written whole folding to accomodate this.
+		// Re-written whole folding to accommodate this.
 		if (options.baanFoldSections && atEOL) {
 			currLineStyle = mainOrSubSectionLine(lineCurrent, styler);
 			nextLineStyle = mainOrSubSectionLine(lineCurrent + 1, styler);
diff --git a/Pythonwin/dllmain.cpp b/Pythonwin/dllmain.cpp
@@ -191,7 +191,7 @@ extern "C" __declspec(dllexport) int __stdcall DllMainwin32ui(HINSTANCE hInstanc
         // insert into resource chain.
         pDLL = new CDynLinkLibrary(extensionDLL);
 
-#else  // Frozen .EXE that embedds win32ui is initializing
+#else  // Frozen .EXE that embeds win32ui is initializing
         TRACE("win32ui in frozen %s initializing.\n", path);
 #endif
     }
diff --git a/Pythonwin/pywin/framework/app.py b/Pythonwin/pywin/framework/app.py
@@ -287,7 +287,7 @@ def OnDropFiles(self, msg):
     # 		except:
     # 			# take copies of the exception values, else other (handled) exceptions may get
     # 			# copied over by the other fns called.
-    # 			win32ui.SetStatusText('An exception occured in a windows command handler.')
+    # 			win32ui.SetStatusText('An exception occurred in a windows command handler.')
     # 			t, v, tb = sys.exc_info()
     # 			traceback.print_exception(t, v, tb.tb_next)
     # 			try:
@@ -297,7 +297,7 @@ def OnDropFiles(self, msg):
 
     # Command handlers.
     def OnFileMRU(self, id, code):
-        "Called when a File 1-n message is recieved"
+        "Called when a File 1-n message is received"
         fileName = win32ui.GetRecentFileList()[id - win32ui.ID_FILE_MRU_FILE1]
         win32ui.GetApp().OpenDocumentFile(fileName)
 
diff --git a/Pythonwin/pywin/idle/readme.md b/Pythonwin/pywin/idle/readme.md
@@ -3,7 +3,7 @@ Pythonwin IDLE directory
 
 This directory contains IDLE extensions used by
 Pythonwin.  The files in this directory that also appear in the main IDLE
-directory are intended be indentical to the latest available for IDLE.
+directory are intended be identical to the latest available for IDLE.
 
 If you use IDLE from the CVS sources, then the files should be
 identical.  If you have a Python version installed that is more recent
diff --git a/Pythonwin/win32uimodule.cpp b/Pythonwin/win32uimodule.cpp
@@ -625,7 +625,7 @@ void DefaultExceptionHandler(int action, const TCHAR *context, const TCHAR *extr
     PyObject *type, *value, *traceback;
     PyErr_Fetch(&type, &value, &traceback);
     if (!type) {
-        TRACE("DefaultExceptionHandler: no exception occured!\n");
+        TRACE("DefaultExceptionHandler: no exception occurred!\n");
         return;
     }
     if (action == EHA_PRINT_ERROR) {
diff --git a/Pythonwin/win32win.cpp b/Pythonwin/win32win.cpp
@@ -429,7 +429,7 @@ PyObject *PyCWnd::CreateControl(PyObject *self, PyObject *args)
                           &id,         // @pyparm int|id||The child ID for the view
                           &obPersist,  // @pyparm object|obPersist|None|Place holder for future support.
                           &bStorage,   // @pyparm int|bStorage|FALSE|Not used.
-                          &obLicKey))  // @pyparm string|licKey|None|The licence key for the control.
+                          &obLicKey))  // @pyparm string|licKey|None|The license key for the control.
         return NULL;
 
     if (!PyWinObject_AsTCHAR(obClass, &szClass, FALSE))
diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ python -m pip install --upgrade pywin32
 There is a post-install script (see below) which should *not* be run inside virtual environments;
 it should only be run in "global" installs.
 
-For unreleased changes, you can download builds made by [github actions](https://github.com/mhammond/pywin32/actions/) -
+For unreleased changes, you can download builds made by [GitHub actions](https://github.com/mhammond/pywin32/actions/) -
 choose any "workflow" from the `main` branch and download its "artifacts"
 
 ### Installing globally
@@ -153,7 +153,7 @@ Since build 307 the release process is based on the artifacts created by Github
   section for the next unreleased version. (ie, a new, empty "Coming in build XXX, as yet unreleased"
   section)
 
-* Push these changes to github, wait for the actions to complete, then
+* Push these changes to GitHub, wait for the actions to complete, then
   download the artifacts from that run.
 
 * Upload `.whl` artifacts to pypi - we do this before pushing the tag because they might be
@@ -164,7 +164,7 @@ Since build 307 the release process is based on the artifacts created by Github
 * Update setup.py with the new build number + ".1" (eg, 123.1), to ensure
   future test builds aren't mistaken for the real release.
 
-* Make sure everything is pushed to github, including the tag (ie,
+* Make sure everything is pushed to GitHub, including the tag (ie,
   `git push --tags`)
 
 * Send mail to python-win32
@@ -186,12 +186,12 @@ the builds. Build 306 was the last released with this process.
 
 * Commit setup.py (so the new build number is in the repo), create a new git tag
 
-* Upload the .exe installers to github.
+* Upload the .exe installers to GitHub.
 
 * Update setup.py with the new build number + ".1" (eg, 123.1), to ensure
   future test builds aren't mistaken for the real release.
 
-* Make sure everything is pushed to github, including the tag (ie,
+* Make sure everything is pushed to GitHub, including the tag (ie,
   `git push --tags`)
 
 * Send mail to python-win32
diff --git a/SWIG/readme.md b/SWIG/readme.md
@@ -4,10 +4,11 @@ SWIG for Win32 Extensions Readme
 This is a release of SWIG 1.1 with slight customizations for Windows.
 This release of SWIG should be used only for building the various Win32
 and COM extensions for Windows.  For the official releases of SWIG and
-more information about SWIG, please visit www.swig.org
+more information about SWIG, please visit <www.swig.org>
 
-To use this:
+To use this
 -----------
+
 You need to set 2 environment variables for this to work.
 
 SWIG_LIB: Required by SWIG, and must be set to point to the "swig_lib"
@@ -17,4 +18,4 @@ SWIG_EXE: Required by the Win32 extension makefiles, and should be the
 fully qualified path to the .exe in this archive.  Note that as this
 environment variable is used by MSVC, you probably need to set this
 variable globally (ie, either in autoexec.bat, or Control Panel->System-
->Environment.
+>Environment).
diff --git a/com/help/asp.d b/com/help/asp.d
@@ -34,11 +34,11 @@ you need some way to tell the server that the following is code. Since
 python is not used by default, you need to set your page to use
 it. You can do that by having the first line say: \<%@ LANGUAGE
 =Python%\>.  Then after that point, anything between '\<%' and '%\>'
-delimeters will run as python code. Everything else will be treated as
+delimeter will run as python code. Everything else will be treated as
 HTML. It is important to note that a python loop ends in the python
 block -- they don't extend past intervening html to the next block. For
 me that normally isn't an issue, since I do not like mixing code and
-html. Prefering a clean split of code and html, I generally
+html. Preferring a clean split of code and html, I generally
 generate webpages using templates all in python w/HTMLgen. Take a look
 at: https://wiki.python.org/moin/WebBrowserProgramming and
 https://wiki.python.org/moin/Asking%20for%20Help/How%20to%20run%20python%20from%20HTML
@@ -70,7 +70,7 @@ for i in query_database():
 
 #notice no raw HTML at all.  We instead use a template html file
 #generated however you want (perhaps frontpage) that substitutes
-#anything delimeted by {} for output from our python.  In this case
+#anything delimited by {} for output from our python.  In this case
 #text {mid} in the template is substituted for results.
 
 import HTMLgen
diff --git a/com/win32com/__init__.py b/com/win32com/__init__.py
@@ -109,7 +109,7 @@ def __PackageSupportBuildPath__(package_path):
         __gen_path__ = os.path.abspath(os.path.join(__path__[0], "gen_py"))
         if not os.path.isdir(__gen_path__):
             # We used to dynamically create a directory under win32com -
-            # but this sucks.  If the dir doesn't already exist, we we
+            # but this sucks.  If the dir doesn't already exist, we
             # create a version specific directory under the user temp
             # directory.
             __gen_path__ = os.path.join(
diff --git a/com/win32com/src/PythonCOM.cpp b/com/win32com/src/PythonCOM.cpp
@@ -748,7 +748,7 @@ static PyObject *pythoncom_WrapObject(PyObject *self, PyObject *args)
     // The gateway must exist (ie, we _must_ support PyGIXXX
 
     // XXX - do we need an optional arg for "base object"?
-    // XXX - If we did, we would unwrap it like thus:
+    // XXX - If we did, we would unwrap it like this:
     /****
     IUnknown *pLook = (IUnknown *)(*ppv);
     IInternalUnwrapPythonObject *pTemp;
diff --git a/com/win32com/test/testExplorer.py b/com/win32com/test/testExplorer.py
@@ -14,7 +14,7 @@
 
 bVisibleEventFired = 0
 
-# These are errors we might see when this is run in automation (eg, on github)
+# These are errors we might see when this is run in automation (eg, on GitHub)
 # Not sure exactly what -2125463506 is, but google shows it's a common error
 # possibly related to how IE is configured WRT site permissions etc.
 HRESULTS_IN_AUTOMATION = [-2125463506, winerror.MK_E_UNAVAILABLE]
diff --git a/com/win32com/test/testall.py b/com/win32com/test/testall.py
@@ -18,7 +18,7 @@
 # rather than the version installed - otherwise every .py change needs a full install to
 # test!
 # We can't patch win32comext as most of them have a .pyd in their root :(
-# This clearly ins't ideal or perfect :)
+# This clearly isn't ideal or perfect :)
 win32com.__path__[0] = win32com_src_dir
 
 import pythoncom
@@ -129,7 +129,7 @@ def testit(self):
           testConversionErrors
         """.split(),
     # Level 2 tests - wants our demo COM objects registered.
-    # (these are strange; on github CI they get further than expected when
+    # (these are strange; on GitHub CI they get further than expected when
     # our objects are not installed, so fail to quietly fail with "can't
     # register" like they do locally. So really just a nod to CI)
     """
diff --git a/com/win32comext/adsi/__init__.py b/com/win32comext/adsi/__init__.py
@@ -21,7 +21,7 @@
 # helpers.
 
 # Of specific note - most of the interfaces supported by ADSI
-# derive from IDispatch - thus, you get the custome methods from the
+# derive from IDispatch - thus, you get the custom methods from the
 # interface, as well as via IDispatch.
 import pythoncom
 
diff --git a/com/win32comext/axscript/client/pyscript_rexec.py b/com/win32comext/axscript/client/pyscript_rexec.py
@@ -5,7 +5,7 @@
 # As of Python 2.2, rexec is simply not available - thus, if you use this,
 # a HTML page can do almost *anything* at all on your machine.
 
-# You almost certainly do NOT want to use thus!
+# You almost certainly do NOT want to use this!
 
 import pythoncom
 from win32com.axscript import axscript
diff --git a/com/win32comext/directsound/src/directsound.cpp b/com/win32comext/directsound/src/directsound.cpp
@@ -353,8 +353,8 @@ PYWIN_MODULE_INIT_FUNC(directsound)
     // in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to
     // play its sticky focus buffers if the user switches to another application not using DirectSound. In this
     // situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is
-    // useful for nongame applications, such as movie playback (DirectShow�), when the user wants to hear the soundtrack
-    // while typing in Microsoft Word or Microsoft� Excel, for example. However, if the user switches to another
+    // useful for nongame applications, such as movie playback (DirectShow®), when the user wants to hear the soundtrack
+    // while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another
     // DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.
     ADD_CONSTANT(DSBCAPS_STICKYFOCUS);
     // @const directsound|DSBCAPS_GLOBALFOCUS|The buffer is a global sound buffer. With this flag set, an application
diff --git a/com/win32comext/directsound/test/ds_test.py b/com/win32comext/directsound/test/ds_test.py
@@ -352,7 +352,7 @@ def testEnumerate(self):
         self.assertTrue(len(devices[0]) == 3)
 
     def testCreate(self):
-        """DirectSoundCreate()"""
+        """DirectSoundCaptureCreate()"""
         try:
             d = ds.DirectSoundCaptureCreate(None, None)
         except pythoncom.com_error as exc:
diff --git a/com/win32comext/mapi/src/exchangeguids.cpp b/com/win32comext/mapi/src/exchangeguids.cpp
@@ -3,7 +3,7 @@
 #define USES_IID_IExchangeFolderACLs
 
 #ifndef BUILD_FREEZE
-/* In a frozen environemt, these are likely to be picked
+/* In a frozen environemnt, these are likely to be picked
 up by the MAPI module */
 
 #define USES_IID_IMsgStore
diff --git a/com/win32comext/shell/demos/servers/column_provider.py b/com/win32comext/shell/demos/servers/column_provider.py
@@ -3,7 +3,7 @@
 #  Using Shell Column Handlers for Detailed File Information,
 #  Raymond Chen, Microsoft Corporation, February 2000
 #
-# To demostrate:
+# To demonstrate:
 # * Execute this script to register the namespace.
 # * Open Windows Explorer
 # * Right-click an explorer column header - select "More"
diff --git a/com/win32comext/shell/demos/servers/context_menu.py b/com/win32comext/shell/demos/servers/context_menu.py
@@ -2,7 +2,7 @@
 # Adds a 'Hello from Python' menu entry to .py files.  When clicked, a
 # simple message box is displayed.
 #
-# To demostrate:
+# To demonstrate:
 # * Execute this script to register the context menu.
 # * Open Windows Explorer, and browse to a directory with a .py file.
 # * Right-Click on a .py file - locate and click on 'Hello from Python' on
diff --git a/com/win32comext/shell/demos/servers/copy_hook.py b/com/win32comext/shell/demos/servers/copy_hook.py
@@ -1,6 +1,6 @@
 # A sample shell copy hook.
 
-# To demostrate:
+# To demonstrate:
 # * Execute this script to register the context menu.
 # * Open Windows Explorer
 # * Attempt to move or copy a directory.
diff --git a/com/win32comext/shell/demos/servers/icon_handler.py b/com/win32comext/shell/demos/servers/icon_handler.py
@@ -2,7 +2,7 @@
 # ICO file.  ICO files are found in the Python directory - generally there will
 # be 3 icons found.
 #
-# To demostrate:
+# To demonstrate:
 # * Execute this script to register the context menu.
 # * Open Windows Explorer, and browse to a directory with a .py file.
 # * Note the pretty, random selection of icons!
diff --git a/com/win32comext/shell/demos/servers/shell_view.py b/com/win32comext/shell/demos/servers/shell_view.py
@@ -1,6 +1,6 @@
 # A sample shell namespace view
 
-# To demostrate:
+# To demonstrate:
 # * Execute this script to register the namespace.
 # * Open Windows Explorer, and locate the new "Python Path Shell Browser"
 #   folder off "My Computer"
diff --git a/isapi/src/Utils.cpp b/isapi/src/Utils.cpp
@@ -104,7 +104,7 @@ char *HTMLErrorResp(const char *msg)
 {
     const char *htmlBody =
         "<html><head><title>Python ISAPI Error</title></head>"
-        "<body><h2>An Error occured while processing your request</h2>"
+        "<body><h2>An Error occurred while processing your request</h2>"
         "<font color=\"Red\"> %s </font></body></html>";
     // should not need the "+1" as the "%s" will be consumed, but...
     int newLen = strlen(htmlBody) + strlen(msg) + 1;
diff --git a/setup.py b/setup.py
@@ -143,7 +143,7 @@ def __init__(
                 ("DISTUTILS_BUILD", None),
                 ("_CRT_SECURE_NO_WARNINGS", None),
                 # CRYPT_DECRYPT_MESSAGE_PARA.dwflags is in an ifdef for some unknown reason
-                # See github PR #1444 for more details...
+                # See GitHub PR #1444 for more details...
                 ("CRYPT_DECRYPT_MESSAGE_PARA_HAS_EXTRA_FIELDS", None),
                 # Minimum Windows version supported (Windows 7)
                 # https://learn.microsoft.com/en-us/cpp/porting/modifying-winver-and-win32-winnt
@@ -1897,9 +1897,9 @@ def expand_modules(module_dir: str | os.PathLike[str]):
 
 
 # NOTE: somewhat counter-intuitively, a result list a-la:
-#  [('Lib/site-packages\\pythonwin', ('pythonwin/license.txt',)),]
-# will 'do the right thing' in terms of installing licence.txt into
-# 'Lib/site-packages/pythonwin/licence.txt'.  We exploit this to
+#  [('Lib/site-packages\\pythonwin', ('pythonwin/License.txt',)),]
+# will 'do the right thing' in terms of installing License.txt into
+# 'Lib/site-packages/pythonwin/License.txt'.  We exploit this to
 # get 'com/win32com/whatever' installed to 'win32com/whatever'
 def convert_data_files(files: Iterable[str]):
     ret: list[tuple[str, tuple[str]]] = []
diff --git a/win32/Lib/win32timezone.py b/win32/Lib/win32timezone.py
@@ -10,7 +10,7 @@
     Copyright © 2003-2012.
     All Rights Reserved.
 
-    This module is licenced for use in Mark Hammond's pywin32
+    This module is licensed for use in Mark Hammond's pywin32
 library under the same terms as the pywin32 library.
 
     To use this time zone module with the datetime module, simply pass
diff --git a/win32/help/security_directories.html b/win32/help/security_directories.html
@@ -9,7 +9,7 @@
 	<TR>
 		<TD valign=middle width="100%"
 		bgcolor="#99ccff"> <font face="sans-serif" size="+1"
-		color="#111111">&nbsp;&nbsp;&nbsp;Extending Python  (directory permisisions w/GetNamedSecurityInfo)  </font>
+		color="#111111">&nbsp;&nbsp;&nbsp;Extending Python  (directory permissions w/GetNamedSecurityInfo)  </font>
 		</TD>
 	</TR>
 	</TABLE>
@@ -542,7 +542,7 @@ <H1><A NAME="Further Info">Further Info</A></H1>
 		<TR>
 			<TD valign=middle
 			bgcolor="#99ccff"> <font face="sans-serif" size="+1"
-			color="#111111">&nbsp;&nbsp;&nbsp;Extending Python  (directory permisisions w/GetNamedSecurityInfo)  </font>
+			color="#111111">&nbsp;&nbsp;&nbsp;Extending Python  (directory permissions w/GetNamedSecurityInfo)  </font>
 			</TD>
 		</TR>
 		</TABLE>
diff --git a/win32/src/win32event.i b/win32/src/win32event.i
@@ -84,9 +84,9 @@
 
 #define EVENT_ALL_ACCESS EVENT_ALL_ACCESS // Specifies all possible access flags for the event object.
 
-#define EVENT_MODIFY_STATE EVENT_MODIFY_STATE // Enables use of the event handle in the SetEvent and ResetEvent�functions to modify the event�s state.
+#define EVENT_MODIFY_STATE EVENT_MODIFY_STATE // Enables use of the event handle in the SetEvent and ResetEvent functions to modify the event's state.
 
-#define SYNCHRONIZE SYNCHRONIZE // Windows NT only:�Enables use of the event handle in any of the wait functions�to wait for the event�s state to be signaled.
+#define SYNCHRONIZE SYNCHRONIZE // Windows NT only: Enables use of the event handle in any of the wait functions to wait for the event's state to be signaled.
 
 // @pyswig |CancelWaitableTimer|Cancels a waiting timer.
 BOOLAPI CancelWaitableTimer(PyHANDLE handle);
diff --git a/win32/src/win32evtlog_messages.mc b/win32/src/win32evtlog_messages.mc
diff --git a/win32/src/win32file.i b/win32/src/win32file.i
diff --git a/win32/src/win32inet.i b/win32/src/win32inet.i
diff --git a/win32/src/win32process.i b/win32/src/win32process.i
diff --git a/win32/src/win32service_messages.mc b/win32/src/win32service_messages.mc
diff --git a/win32/test/handles.py b/win32/test/handles.py
diff --git a/win32/test/test_win32file.py b/win32/test/test_win32file.py

Original file line number	Diff line number	Diff line change
`@@ -191,7 +191,7 @@ extern "C" __declspec(dllexport) int __stdcall DllMainwin32ui(HINSTANCE hInstanc`
`191`	`191`	`// insert into resource chain.`
`192`	`192`	`pDLL = new CDynLinkLibrary(extensionDLL);`
`193`	`193`
`194`		`-#else // Frozen .EXE that embedds win32ui is initializing`
	`194`	`+#else // Frozen .EXE that embeds win32ui is initializing`
`195`	`195`	`TRACE("win32ui in frozen %s initializing.\n", path);`
`196`	`196`	`#endif`
`197`	`197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -625,7 +625,7 @@ void DefaultExceptionHandler(int action, const TCHAR context, const TCHAR extr`
`625`	`625`	`PyObject type, value, *traceback;`
`626`	`626`	`PyErr_Fetch(&type, &value, &traceback);`
`627`	`627`	`if (!type) {`
`628`		`- TRACE("DefaultExceptionHandler: no exception occured!\n");`
	`628`	`+ TRACE("DefaultExceptionHandler: no exception occurred!\n");`
`629`	`629`	`return;`
`630`	`630`	`}`
`631`	`631`	`if (action == EHA_PRINT_ERROR) {`