delete config

[stan-dot]

No description provided.

[callumforrester]

Tests that check the config is valid also need to be removed

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.41%. Comparing base (fb6fd0c) to head (4b480c9).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #408      +/-   ##
==========================================
- Coverage   89.52%   89.41%   -0.12%     
==========================================
  Files          43       43              
  Lines        1805     1805              
==========================================
- Hits         1616     1614       -2     
- Misses        189      191       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[callumforrester]

LGTM

[tpoliaw]

There are still references to this file in docs and a(n unused) test fixture that relies on it. It would be good if the docs could be updated to either include some example config or link to somewhere some examples can be found.

[stan-dot]

hmmm, please say which fille

[tpoliaw]

Sorry, the defaults.yaml file

(⇅ 3) v3.10.13 (blueapi) /scratch/athena/blueapi (main)[*?]
❯ rg -C2 'defaults.yaml'
tests/[email protected]
tests/test_config.py-54-def default_yaml(package_root: Path) -> Path:
tests/test_config.py:55:    return package_root.parent.parent / "config" / "defaults.yaml"
tests/test_config.py-56-
tests/test_config.py-57-
--
docs/how-to/configure-app.md-5-can be passed to the `blueapi` command.
docs/how-to/configure-app.md-6-
docs/how-to/configure-app.md:7:An example of this yaml file is found in `config/defaults.yaml`, which follows
docs/how-to/configure-app.md-8-the schema defined in `src/blueapi/config.py` in the `ApplicationConfig`
docs/how-to/configure-app.md-9-object.

[stan-dot]

would putting it inside the ConfigLoader docstring be suitable?

C = TypeVar("C", bound=BaseModel)


class ConfigLoader(Generic[C]):
    """
    Small utility class for loading config from various sources.
    You must define a config schema as a dataclass (or series of
    nested dataclasses) that can then be loaded from some combination
    of default values, dictionaries, YAML/JSON files etc.
    """

    _schema: type[C]
    _values: dict[str, Any]

src/blueapi/config.py lines 115 and later?

[tpoliaw]

That would be good as well, but I think having examples in the docs without having to read through the code would be helpful for setting up new environments.