mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-20 07:31:39 +01:00
docs(repo): the contract of each Platform member, and the quirks
The audit behind the docstrings of Platform: what each member promises to both ports, what each port answers for another reason, what each finding of the review turned out to be, and what is left to run on a KDE VM and on Windows.
This commit is contained in:
1 parent
40eba4aade
commit
1b655251dd
2 files changed
+86
-1
No files matched your search
@@ -162,7 +162,8 @@ the run.
|
||||
`startup_rules` and `focus_follows_mouse`. A method is added with the first scenario that
|
||||
needs it: `restart_with(config)` starts the daemon afresh with a `komorebi.json` the
|
||||
scenario gives. `KdePlatform` (`kde_platform.py`) is a `Kde` session as a `Platform`.
|
||||
[Writing a scenario](#writing-a-scenario) says how to add one.
|
||||
[platform-contract.md](platform-contract.md) says what each member promises both ports and
|
||||
what a scenario may not lean on. [Writing a scenario](#writing-a-scenario) says how to add one.
|
||||
|
||||
A check that a port is known to fail is recorded with `Checks.known_failure(description,
|
||||
condition, reason)`: it does not fail the suite, the totals say `known failures: N`, and
|
||||
|
||||
Reference in new issue
Block a user