From 7536e33ed152a2ccdfcbf474eae478112db88553 Mon Sep 17 00:00:00 2001
From: Douglas RAILLARD <douglas.raillard@arm.com>
Date: Mon, 28 Jan 2019 15:55:07 +0000
Subject: [PATCH] env: Add docstrings to some TestEnv methods

---
 lisa/env.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lisa/env.py b/lisa/env.py
index 2190d6b7d..27edf8cc8 100644
--- a/lisa/env.py
+++ b/lisa/env.py
@@ -268,11 +268,21 @@ class TestEnv(Loggable, HideExekallID):
 
     @classmethod
     def from_default_conf(cls):
+        """
+        Create a :class:`TestEnv` from the YAML configuration file pointed by
+        ``LISA_CONF`` environment variable.
+        """
         path = os.environ['LISA_CONF']
         return cls.from_one_conf(path)
 
     @classmethod
     def from_one_conf(cls, path):
+        """
+        Create a :class:`TestEnv` from a single YAML configuration file.
+
+        This file will be used to provide a :class:`TargetConf` and
+        :class:`lisa.platforms.platinfo.PlatformInfo` instances.
+        """
         target_conf = TargetConf.from_yaml_map(path)
         try:
             plat_info = PlatformInfo.from_yaml_map(path)
-- 
GitLab