docs: quote flags and split clauses in comments

This commit is contained in:
Abdessamad Derraz committed 2026-11-10 06:47:50 +01:00
1 parent 27c33b966e
commit 14f1dbe50d
5 files changed
+10 -10

No files matched your search

+3 -3
View File
@@ -543,7 +543,7 @@
}
},
"roms_directory": {
"description": "Where the platform keeps its roms root, present when an entry carries root: roms. from_bios is that root relative to the BIOS folder (\".\" for the folder itself, else one or two \"..\" then plain names), as platforms/romfolders/<platform>.yml records it from the OS's own source (roms_root.from_bios). It is followed only from a BIOS folder named bios_folder (the platform's base_destination); any other leaves root: roms entries out (no_roms_directory).",
"description": "Where the platform keeps its roms root, present when an entry carries root: roms. from_bios is that root relative to the BIOS folder (\".\" for the folder itself, else one or two \"..\" then plain names), as platforms/romfolders/<platform>.yml records it from the OS's own source (roms_root.from_bios). It is followed only from a BIOS folder named bios_folder (the platform's base_destination). Any other leaves root: roms entries out (no_roms_directory).",
"type": "object",
"additionalProperties": false,
"required": [
@@ -577,7 +577,7 @@
],
"properties": {
"bios_folder": {
"description": "Name of the BIOS folder; the other paths are relative to the folder holding it.",
"description": "Name of the BIOS folder. The other paths are relative to the folder holding it.",
"type": "string",
"minLength": 1,
"pattern": "^[^/\\\\]+$"
@@ -604,7 +604,7 @@
}
},
"configs_directory": {
"description": "Where the frontend keeps its emulators' configs, present when an entry carries root: configs. from_bios is that folder relative to the BIOS folder, as the platform's own path code builds it (Batocera's batoceraPaths CONFIGS, ../system/configs), with the rules of roms_directory.from_bios. It is followed only from a BIOS folder named bios_folder; any other leaves root: configs entries out (no_configs_directory).",
"description": "Where the frontend keeps its emulators' configs, present when an entry carries root: configs. from_bios is that folder relative to the BIOS folder, as the platform's own path code builds it (Batocera's batoceraPaths CONFIGS, ../system/configs), with the rules of roms_directory.from_bios. It is followed only from a BIOS folder named bios_folder. Any other leaves root: configs entries out (no_configs_directory).",
"type": "object",
"additionalProperties": false,
"required": [
+4 -4
View File
@@ -402,8 +402,8 @@ class HandedDirectory:
# The placeholder a launcher record writes for the system it is launched
# for, as Recalbox's extractor spells it: Recalbox passes XRoar -rompath
# os.path.join(BIOS, args.system).
# for, as Recalbox's extractor spells it: Recalbox passes XRoar `-rompath`
# `os.path.join(BIOS, args.system)`.
SYSTEM_PLACEHOLDER = "<system>"
@@ -772,7 +772,7 @@ def standalone_bindings(
``systems`` are the platform systems, by our ids, an entry is launched
for. A record naming systems replaces, for those systems, what the
records naming none give: RetroBat passes XRoar -rompath bios/coco for
records naming none give: RetroBat passes XRoar `-rompath bios/coco` for
coco and bios/dragon for every other system.
A profile whose program reads its files beside its executable declares
@@ -1003,7 +1003,7 @@ class LauncherLayer:
names = own & basenames
if names:
return _Candidate(entry, names, False)
# RetroPie runs sdl2trs with -romfile4p $biosdir/level4p.rom: the
# RetroPie runs sdl2trs with `-romfile4p $biosdir/level4p.rom`: the
# file under that name is the one the romfile4p slot reads.
if set_by(entry, place.passes_to):
return _Candidate(entry, basenames, False, by_setting_or_stem=True)
+1 -1
View File
@@ -253,7 +253,7 @@ class LauncherLayerTest(unittest.TestCase):
self.assertNotIn("core.bin", self._pack_names())
def test_a_file_handed_to_an_entry_setting_takes_the_entry_content(self) -> None:
"""RetroPie runs sdl2trs with -romfile4p $biosdir/level4p.rom and
"""RetroPie runs sdl2trs with `-romfile4p $biosdir/level4p.rom` and
EmuDeck writes a No-Intro name into ares's NeoGeoPocket firmware
setting: neither name is the core's, and the held file of the entry
that setting reads went in under no name at all."""
+1 -1
View File
@@ -277,7 +277,7 @@ class OnlyWhatABoardBuildsIsRun(unittest.TestCase):
def test_only_what_a_board_builds_or_the_user_supplies_is_run(self):
from scraper import batocera_scraper as bs
# A board selects kodi's package and buildroot's mpv; citron is
# A board selects kodi's package and buildroot's mpv. Citron is
# listed by es_systems, so the symbol of a folder of that name does
# not count for it.
built = bs.boards_build(
+1 -1
View File
@@ -257,7 +257,7 @@ class PerSystem(unittest.TestCase):
)
def test_a_system_placeholder_gives_one_directory_per_system(self) -> None:
# Recalbox passes -rompath os.path.join(BIOS, args.system).
# Recalbox passes `-rompath os.path.join(BIOS, args.system)`.
cfg = {
**config(passes("emu", "/recalbox/share/bios/<system>", "command line -rompath")),
"systems": {