Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

edk2_invocable.py: Improve documentation #786

Merged
merged 5 commits into from
Apr 5, 2024
Merged

edk2_invocable.py: Improve documentation #786

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
062a6d5
Update edk2_invocable.py
yangrongwei Apr 5, 2024
3a2bf73
Update edk2_invocable.py
yangrongwei Apr 5, 2024
2cf5448
Update edk2_invocable.py
yangrongwei Apr 5, 2024
150eaa0
Update edk2_invocable.py
yangrongwei Apr 5, 2024
e12d2b6
Update edk2_invocable.py
yangrongwei Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions edk2toolext/edk2_invocable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"""

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 @@
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,
(a) Absolute path

Check failure on line 98 in edk2toolext/edk2_invocable.py

View workflow job for this annotation

GitHub Actions / CI / Run

Ruff (W291) 

edk2toolext/edk2_invocable.py:98:30: W291 Trailing whitespace
(b) Relative to WORKSPACE
(c) Relative to current working dir

Check failure on line 101 in edk2toolext/edk2_invocable.py

View workflow job for this annotation

GitHub Actions / CI / Run

Ruff (W293) 

edk2toolext/edk2_invocable.py:101:1: W293 Blank line contains whitespace
See Also,
https://github.com/tianocore/tianocore.github.io/wiki/Multiple_Workspace

Check failure on line 104 in edk2toolext/edk2_invocable.py

View workflow job for this annotation

GitHub Actions / CI / Run

Ruff (W293) 

edk2toolext/edk2_invocable.py:104:1: W293 Blank line contains whitespace
Returns:
(Iterable[os.PathLike]): paths
"""
Expand Down
Loading