Apply suggestions from code review

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
python · AlexWaygood · Nov 11, 2022 · Oct 18, 2022 · Oct 18, 2022 · Oct 18, 2022
commit faac1be5cc4b06b62b4f04c6c2b3875f03e7d2df
diff --git a/.github/workflows/stubtest_third_party.yml b/.github/workflows/stubtest_third_party.yml
@@ -40,8 +40,7 @@ jobs:
         run: |
           STUBS=$(
             git diff --name-only origin/${{ github.base_ref }} HEAD |
-            # Uncomment the following to (very slowly) run on all third party stubs:
-            # git ls-files |
+            # Use the daily.yml workflow to run stubtest on all third party stubs
             egrep ^stubs/ | cut -d "/" -f 2 | sort -u | (while read stub; do [ -d stubs/$stub ] && echo $stub || true; done)
           )
 
@@ -58,11 +57,12 @@ jobs:
             fi
 
             if [ "${{ matrix.os }}" = "macos-latest" ]; then
-              # TODO: install brew packages
+              # Could install brew packages here if we run into stubs that need it
               python tests/stubtest_third_party.py $STUBS
             fi
 
             if [ "${{ matrix.os }}" = "windows-latest" ]; then
+              # Could install choco packages here if we run into stubs that need it
               python tests/stubtest_third_party.py $STUBS
             fi
           else

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -194,7 +194,7 @@ This has the following keys:
   usually packages needed to pip install the implementation distribution.
 * `platforms` (default: `["linux"]`): A list of OSes on which to run stubtest.
   Can contain `win32`, `linux`, and `darwin` values.
-  If not specified, tests are run only on `linux`.
+  If not specified, stubtest is run only on `linux`.
   Only add extra OSes to the test
   if there are platform-specific branches in a stubs package.
 

diff --git a/stubs/D3DShot/METADATA.toml b/stubs/D3DShot/METADATA.toml
@@ -2,6 +2,5 @@ version = "0.1.*"
 requires = ["types-Pillow"]
 
 [tool.stubtest]
-# TODO: re-enable
 skip = true
 platforms = ["win32"]