diff --git a/docs/users/db.md b/docs/users/db.md index 5be3dc5..26e822f 100644 --- a/docs/users/db.md +++ b/docs/users/db.md @@ -9,6 +9,13 @@ Note that all databases, i.e., for all different grain types ("sic", ...) can be managed with this tool. +## Currently impelmented databases + +The following grain types are currently implemented: + +- `"sic"`: Silicon carbide +- `"gra"`: Graphite + ## Background In order to be able to update the database without updating the package, diff --git a/tests/data_files/db.json b/tests/data_files/db.json index eb42b1e..be3af87 100644 --- a/tests/data_files/db.json +++ b/tests/data_files/db.json @@ -58,7 +58,7 @@ } ] }, - "graphites": { + "gra": { "db_name": "Graphite", "versions":[ { diff --git a/tests/test_db/conftest.py b/tests/test_db/conftest.py index 9d132a6..7e0c571 100644 --- a/tests/test_db/conftest.py +++ b/tests/test_db/conftest.py @@ -23,7 +23,7 @@ def conf_files(tmpdir_home, data_files_dir) -> Path: @pytest.fixture def current_file(tmpdir_home) -> Tuple[Path, dict]: """Create a fake `current.json` file and write into the right location.""" - curr_to_write = {"sic": "test.csv", "graphites": "test-graphites.csv"} + curr_to_write = {"sic": "test.csv", "gra": "test-graphites.csv"} curr_ret = {k: Path(v) for k, v in curr_to_write.items()} with open(tmpdir_home.joinpath("current.json"), "w") as fout: diff --git a/tests/test_db/test_config.py b/tests/test_db/test_config.py index 1dce8c8..70303a3 100644 --- a/tests/test_db/test_config.py +++ b/tests/test_db/test_config.py @@ -18,7 +18,7 @@ def test_databases_conf_not_found(): def test_databases_dbs(conf_files): """Assert that the database reader returns all databases when asked.""" db = DataBases() - assert db.dbs == ["sic", "graphites"] + assert db.dbs == ["sic", "gra"] def test_databases_urls_all(conf_files):