From 32240d4276cd47172f250579b2560fd1438479f2 Mon Sep 17 00:00:00 2001
From: Dylan Baker <dylan@pnwbakers.com>
Date: Tue, 14 Jan 2020 14:57:35 -0800
Subject: [PATCH] dependencies: Add comment to the packages dict

---
 mesonbuild/dependencies/__init__.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/mesonbuild/dependencies/__init__.py b/mesonbuild/dependencies/__init__.py
index c8143b984..d961117e8 100644
--- a/mesonbuild/dependencies/__init__.py
+++ b/mesonbuild/dependencies/__init__.py
@@ -33,6 +33,11 @@ from .platform import AppleFrameworks
 from .ui import GnuStepDependency, Qt4Dependency, Qt5Dependency, WxDependency, gl_factory, sdl2_factory, vulkan_factory
 
 
+# This is a dict where the keys should be strings, and the values must be one
+# of:
+# - An ExternalDependency subclass
+# - A DependencyFactory object
+# - A callable with a signature of (Environment, MachineChoice, Dict[str, Any]) -> List[Callable[[], DependencyType]]
 packages.update({
     # From dev:
     'gtest': gtest_factory,