update env 🌳

state-alchemists · Dec 7, 2023 · 00ef2e4 · 00ef2e4
1 parent a46e3ba
commit 00ef2e4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/concepts/task-env.md b/docs/concepts/task-env.md
@@ -6,6 +6,13 @@
 ## `Env`
 Task Environment
 
+__Attributes:__
+
+- `name` (`str`): environment name as recognized by Task.
+- `os_name` (`Optional[str]`): OS's environment name. Empty string for no os_name.
+- `default` (`JinjaTemplate`): Default value of the environment
+- `should_render` (`bool`): Whether the environment value should be rendered or not.
+
 ### `Env._Env__get_prefixed_name`
 No documentation available.
 

diff --git a/src/zrb/task_env/env.py b/src/zrb/task_env/env.py
@@ -8,6 +8,12 @@
 class Env():
     '''
     Task Environment
+
+    Attributes:
+        name (str): environment name as recognized by Task.
+        os_name (Optional[str]): OS's environment name. Empty string for no os_name.
+        default (JinjaTemplate): Default value of the environment
+        should_render (bool): Whether the environment value should be rendered or not.
     '''
 
     def __init__(