Skip to content

Commit

Permalink
edk2_invocable.py: Improve documentation (#786)
Browse files Browse the repository at this point in the history
Improve the in-line documentation for edk2_invocable.py, which improves the quality of documentation at https://www.tianocore.org/edk2-pytool-extensions/
  • Loading branch information
yangrongwei authored Apr 5, 2024
1 parent c32da9b commit 9a90e71
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions edk2toolext/edk2_invocable.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -89,11 +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 PackagePaths.
"""Provides an iterable of paths which will be mapped as edk2 PACKAGES_PATH.
!!! tip
Optional Override in a subclass
Path can be,
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
"""
Expand Down

0 comments on commit 9a90e71

Please sign in to comment.