diff mbox series

[11/13] lib/oe/purl: improve docstrings

Message ID 20261116-oe-lib-docstrings-v1-11-0c894f6a1064@bootlin.com
State New
Headers show
Series Improve or add oe.* library docstrings | expand

Commit Message

Antonin Godard Nov. 16, 2026, 4:09 p.m. UTC
Improve docstrings by detailing the parameters and return values of
functions in this module.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 meta/lib/oe/purl.py | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/meta/lib/oe/purl.py b/meta/lib/oe/purl.py
index 2f92a23596..ed158d7f81 100644
--- a/meta/lib/oe/purl.py
+++ b/meta/lib/oe/purl.py
@@ -11,16 +11,17 @@  PREFIX = "pkg:yocto"
 
 def quote(s):
     """
-    Returns the percent encoded version of the string, suitable for including
-    in a PURL field
+    Return the percent encoded version of the string ``s``, suitable for inclusion
+    in a PURL field.
     """
     return urllib.parse.quote(s, safe="")
 
 
 def get_base_purl(d):
     """
-    Returns the base PURL for the current recipe (that is, the PURL without any
-    additional qualifiers)
+    Return the base PURL for the current recipe (that is, the PURL without any
+    additional qualifiers), using ``d`` (the :term:`datastore`) to access the recipe's
+    variables.
     """
     layername = d.getVar("FILE_LAYERNAME")
     bpn = d.getVar("BPN")