From f031c6e452ad883424d65227a558bc4155f6039e Mon Sep 17 00:00:00 2001
From: seth <getchoo@tuta.io>
Date: Fri, 24 May 2024 23:17:20 -0400
Subject: document lib

---
 lib/nginx.nix | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'lib/nginx.nix')

diff --git a/lib/nginx.nix b/lib/nginx.nix
index bcf3332..0564dba 100644
--- a/lib/nginx.nix
+++ b/lib/nginx.nix
@@ -1,4 +1,7 @@
 lib: {
+  # string -> int -> { }
+  # create an nginx virtualHost submodule proxying local port
+  # `port` to `endpoint`
   mkProxy = endpoint: port: {
     "${endpoint}" = {
       proxyPass = "http://localhost:${toString port}";
@@ -6,6 +9,9 @@ lib: {
     };
   };
 
+  # string -> { } -> { }
+  # transform the names of an attribute set of nginx virtualHosts
+  # into a full subdomain
   toVHosts = domain:
     lib.mapAttrs' (
       name: lib.nameValuePair "${name}.${domain}"
-- 
cgit v1.2.3