piker/piker
Gud Boi 70b663992c Better doc-strings n styling in `piker.cli` eps
Add comprehensive docstrings to the top-level CLI endpoints and helpers,
explaining the purpose and structure of each (sub)command.

Deats,
- add detailed docstring to `pikerd()` explaining its role as the
  root service-actor/daemon supervisor.
- add docstring to `cli()` noting it's the root endpoint generally
  requiring a sub-cmd input.
- add extensive docstring to `services()` explaining the daemon naming
  conventions and listing a few current/common service actors.
- add docstring to `_load_clis()` explaining dynamic CLI loading.

Stylin,
- add multiline style to `and not maddrs` conditional in
  `load_trans_eps()`.
- drop commented-out `--tsdb` and `--es` click options from
  `pikerd()`, they're more or less obsolete given `nativedb`.
- add type annots where obviously handy.
- add TODO comment about UDS support in `services()`.

(this commit msg was generated in some part by [`claude-code`][claude-code-gh])
[claude-code-gh]: https://github.com/anthropics/claude-code
2026-02-22 22:09:05 -05:00
..
accounting Enable console logging in `.accounting` on import 2026-02-22 22:09:05 -05:00
brokers Use `name=__name__` for logs throughout `.service` 2026-02-22 22:09:05 -05:00
clearing Enable console via `.clearing._ems.open_brokerd_dialog()` 2026-02-22 22:09:05 -05:00
cli Better doc-strings n styling in `piker.cli` eps 2026-02-22 22:09:05 -05:00
data Pass `loglevel` down through `.data` callstack 2026-02-22 22:09:05 -05:00
fsp Pass `loglevel` to `cascade()` feed/sampler opens 2026-02-22 22:09:05 -05:00
service Use `name=__name__` for logs throughout `.service` 2026-02-22 22:09:05 -05:00
storage Replace assert with warn for no-gaps in `.storage.cli` 2026-02-22 22:08:35 -05:00
testing Pass a config `tmp_dir: Path` to the runtime when testing 2023-03-09 15:37:43 -05:00
toolz Delegate `.toolz.open_crash_handler()` to `tractor.devx` 2024-01-16 10:26:38 -05:00
tsp Pass `loglevel` down through `.data` callstack 2026-02-22 22:09:05 -05:00
ui Pass `loglevel` down through `.ui` graphics tasks 2026-02-22 22:09:05 -05:00
watchlists Add license headers to pertinent files 2020-11-06 12:23:14 -05:00
__init__.py Start `piker.service` sub-package 2023-03-09 15:37:42 -05:00
_cacheables.py Move `._cacheables.open_cached_client()` into `.brokers` pkg mod 2023-06-27 13:41:47 -04:00
calc.py Lul, adhere to returning `str`s in `humanize()` 2022-01-25 07:57:01 -05:00
config.py `.config.get_app_dir()`: link to `click`'s orig impl on GH 2026-01-06 19:33:23 -05:00
log.py Auto-enable `tractor` logging when runtime active 2026-02-22 22:09:05 -05:00
types.py Point `.types.Struct` to `tractor.msg.pretty_struct` 2026-02-22 16:07:53 -05:00