Merge pull request #174 from brcrista/patch-1

Document why we build from source on macOS
actions · Jun 29, 2022 · eaa180e · eaa180e
2 parents 73379f9 + 12ba644
commit eaa180e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/builders/macos-python-builder.psm1 b/builders/macos-python-builder.psm1
@@ -7,6 +7,10 @@ class macOSPythonBuilder : NixPythonBuilder {
 
     .DESCRIPTION
     Contains methods that required to build macOS Python artifact from sources. Inherited from base NixPythonBuilder.
+    
+    While python.org provides precompiled binaries for macOS, switching to them risks breaking existing customers.
+    If we wanted to start using the official binaries instead of building from source, we should avoid changing previous versions
+    so we remain backwards compatible.
 
     .PARAMETER platform
     The full name of platform for which Python should be built.