From 062a6d5111c3b04c2f98435cfcf9512736aef5fa Mon Sep 17 00:00:00 2001
From: RaymondY <yangrongwei@hotmail.com>
Date: Fri, 5 Apr 2024 21:14:14 +0800
Subject: [PATCH 1/5] Update edk2_invocable.py

Refine comment
---
 edk2toolext/edk2_invocable.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/edk2toolext/edk2_invocable.py b/edk2toolext/edk2_invocable.py
index ec648a3e..f9510698 100644
--- a/edk2toolext/edk2_invocable.py
+++ b/edk2toolext/edk2_invocable.py
@@ -89,10 +89,11 @@ def GetWorkspaceRoot(self) -> str:
         raise NotImplementedError()
 
     def GetPackagesPath(self) -> Iterable[os.PathLike]:
-        """Provides an iterable of paths should should be mapped as edk2 PackagePaths.
+        """Provides an iterable of paths should should be mapped as edk2 PACKAGES_PATH.
 
         !!! tip
             Optional Override in a subclass
+            https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace
 
         Returns:
             (Iterable[os.PathLike]): paths

From 3a2bf732565612e4038e0b0f0b83bb95bdaf1b31 Mon Sep 17 00:00:00 2001
From: RaymondY <yangrongwei@hotmail.com>
Date: Fri, 5 Apr 2024 21:44:38 +0800
Subject: [PATCH 2/5] Update edk2_invocable.py

---
 edk2toolext/edk2_invocable.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/edk2toolext/edk2_invocable.py b/edk2toolext/edk2_invocable.py
index f9510698..471116ef 100644
--- a/edk2toolext/edk2_invocable.py
+++ b/edk2toolext/edk2_invocable.py
@@ -76,7 +76,7 @@ def GetSkippedDirectories(self) -> Tuple[str]:
     """
 
     def GetWorkspaceRoot(self) -> str:
-        """Return the workspace root for initializing the SDE.
+        """Return the workspace root for initializing the SDE, will be mapped as edk2 WORKSPACE.
 
         !!! tip
             Required Override in a subclass
@@ -89,12 +89,19 @@ def GetWorkspaceRoot(self) -> str:
         raise NotImplementedError()
 
     def GetPackagesPath(self) -> Iterable[os.PathLike]:
-        """Provides an iterable of paths should should be mapped as edk2 PACKAGES_PATH.
+        """Provides an iterable of paths which will be mapped as edk2 PACKAGES_PATH.
 
         !!! tip
             Optional Override in a subclass
-            https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace
 
+        Path can be,
+            Absolute path 
+            Relative to WORKSPACE
+            Relative to current working dir
+        
+        See Also,
+            https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace
+            
         Returns:
             (Iterable[os.PathLike]): paths
         """

From 2cf54481f2613cdbc3309eec0e4efb9542a2c03d Mon Sep 17 00:00:00 2001
From: RaymondY <yangrongwei@hotmail.com>
Date: Fri, 5 Apr 2024 21:49:07 +0800
Subject: [PATCH 3/5] Update edk2_invocable.py

---
 edk2toolext/edk2_invocable.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/edk2toolext/edk2_invocable.py b/edk2toolext/edk2_invocable.py
index 471116ef..81fd0e65 100644
--- a/edk2toolext/edk2_invocable.py
+++ b/edk2toolext/edk2_invocable.py
@@ -95,9 +95,9 @@ def GetPackagesPath(self) -> Iterable[os.PathLike]:
             Optional Override in a subclass
 
         Path can be,
-            Absolute path 
-            Relative to WORKSPACE
-            Relative to current working dir
+            (a) Absolute path 
+            (b) Relative to WORKSPACE
+            (c) Relative to current working dir
         
         See Also,
             https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace

From 150eaa01a67f10048d938ec34264861991bfd46d Mon Sep 17 00:00:00 2001
From: RaymondY <yangrongwei@hotmail.com>
Date: Fri, 5 Apr 2024 22:47:00 +0800
Subject: [PATCH 4/5] Update edk2_invocable.py

Use list markup
---
 edk2toolext/edk2_invocable.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/edk2toolext/edk2_invocable.py b/edk2toolext/edk2_invocable.py
index 81fd0e65..3b48015a 100644
--- a/edk2toolext/edk2_invocable.py
+++ b/edk2toolext/edk2_invocable.py
@@ -95,9 +95,9 @@ def GetPackagesPath(self) -> Iterable[os.PathLike]:
             Optional Override in a subclass
 
         Path can be,
-            (a) Absolute path 
-            (b) Relative to WORKSPACE
-            (c) Relative to current working dir
+            1. Absolute or
+            2. Relative to WORKSPACE or
+            3. Relative to current working dir
         
         See Also,
             https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace

From e12d2b6d26b0bd9ad5f38444c8f1ab71f96defde Mon Sep 17 00:00:00 2001
From: RaymondY <yangrongwei@hotmail.com>
Date: Fri, 5 Apr 2024 22:52:19 +0800
Subject: [PATCH 5/5] Update edk2_invocable.py

make checker happy
---
 edk2toolext/edk2_invocable.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/edk2toolext/edk2_invocable.py b/edk2toolext/edk2_invocable.py
index 3b48015a..284087ae 100644
--- a/edk2toolext/edk2_invocable.py
+++ b/edk2toolext/edk2_invocable.py
@@ -98,10 +98,10 @@ def GetPackagesPath(self) -> Iterable[os.PathLike]:
             1. Absolute or
             2. Relative to WORKSPACE or
             3. Relative to current working dir
-        
+
         See Also,
             https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace
-            
+
         Returns:
             (Iterable[os.PathLike]): paths
         """