Administration/pmbootstrap-meow
2
0
Fork 0
forked from Mirror/pmbootstrap
Code Pull requests Activity Actions

pmb.*: various comment reformatting to assist with generating docs (MR 2266)

Browse source
This commit is contained in:
Robert Eckelmann 2024-05-08 14:39:48 -07:00 • committed by Newbyte
parent 415e7364f4
commit 044d3b5a6a
No known key found for this signature in database
GPG key ID: 8A700086A9FE41FD
43 changed files with 592 additions and 599 deletions
Download patch file Download diff file Expand all files Collapse all files

20
pmb/helpers/devices.py
View file

@ -6,8 +6,8 @@ import pmb.parse
def find_path(args, codename, file=''):
"""
Find path to device APKBUILD under `device/*/device-`.
"""Find path to device APKBUILD under `device/*/device-`.
:param codename: device codename
:param file: file to look for (e.g. APKBUILD or deviceinfo), may be empty
:returns: path to APKBUILD
@ -24,8 +24,8 @@ def find_path(args, codename, file=''):
def list_codenames(args, vendor=None, unmaintained=True):
"""
Get all devices, for which aports are available
"""Get all devices, for which aports are available.
:param vendor: vendor name to choose devices from, or None for all vendors
:param unmaintained: include unmaintained devices
:returns: ["first-device", "second-device", ...]
@ -41,8 +41,8 @@ def list_codenames(args, vendor=None, unmaintained=True):
def list_vendors(args):
"""
Get all device vendors, for which aports are available
"""Get all device vendors, for which aports are available.
:returns: {"vendor1", "vendor2", ...}
"""
ret = set()
@ -53,9 +53,7 @@ def list_vendors(args):
def list_apkbuilds(args):
"""
:returns: { "first-device": {"pkgname": ..., "pkgver": ...}, ... }
"""
""":returns: { "first-device": {"pkgname": ..., "pkgver": ...}, ... }"""
ret = {}
for device in list_codenames(args):
apkbuild_path = f"{args.aports}/device/*/device-{device}/APKBUILD"
@ -64,9 +62,7 @@ def list_apkbuilds(args):
def list_deviceinfos(args):
"""
:returns: { "first-device": {"name": ..., "screen_width": ...}, ... }
"""
""":returns: { "first-device": {"name": ..., "screen_width": ...}, ... }"""
ret = {}
for device in list_codenames(args):
ret[device] = pmb.parse.deviceinfo(args, device)