From 3853f19fd536a8398847f161049ab7ae527128c5 Mon Sep 17 00:00:00 2001
From: Sebastian Malton <sebastian@malton.name>
Date: Fri, 4 Nov 2022 09:23:51 -0400
Subject: [PATCH] Add function description

Signed-off-by: Sebastian Malton <sebastian@malton.name>
---
 .../shell-env/compute-unix-shell-environment.injectable.ts   | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main/utils/shell-env/compute-unix-shell-environment.injectable.ts b/src/main/utils/shell-env/compute-unix-shell-environment.injectable.ts
index db09a0809e..d26a3ee29c 100644
--- a/src/main/utils/shell-env/compute-unix-shell-environment.injectable.ts
+++ b/src/main/utils/shell-env/compute-unix-shell-environment.injectable.ts
@@ -19,6 +19,11 @@ export interface UnixShellEnvOptions {
 
 export type ComputeUnixShellEnvironment = (shell: string, opts: UnixShellEnvOptions) => Promise<AsyncResult<EnvironmentVariables, string>>;
 
+/**
+ * @param src The object containing the current environment variables
+ * @param overrides The environment variables that want to be overridden before passing the env to a child process
+ * @returns The combination of environment variables and a function which resets an object of environment variables to the values the keys corresponded to in `src` (rather than `overrides`)
+ */
 const getResetProcessEnv = (src: Partial<Record<string, string>>, overrides: Partial<Record<string, string>>): {
   resetEnvPairs: (target: Partial<Record<string, string>>) => void;
   env: Partial<Record<string, string>>;