Skip to content

Commit b9f71ab

Browse files
committed
get_env: clarify documentation and security risk
1 parent 228107e commit b9f71ab

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

batchspawner/batchspawner.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -499,11 +499,12 @@ def user_env(self, env):
499499
return env
500500

501501
def get_env(self):
502-
"""Add user environment variables.
502+
"""Get user environment variables to be passed to the user's job
503503
504-
Everything here should be passed to the user's job. If it is
505-
used to authenticate to the batch system commands as an admin,
506-
beware that the user will get them too.
504+
Everything here should be passed to the user's job as
505+
environment. Caution: If these variables are used for
506+
authentication to the batch system commands as an admin, be
507+
aware that the user will receive access to these as well.
507508
"""
508509
env = super().get_env()
509510
env = self.user_env(env)

0 commit comments

Comments
 (0)