From 5fa2652f7651b99009da72af75f41166b1b03dd4 Mon Sep 17 00:00:00 2001 From: Ben Pedigo Date: Fri, 19 Jan 2024 10:08:53 -0800 Subject: [PATCH] add notes --- docs/client_api/chunkedgraph.md | 18 +++++++----------- docs/client_api/index.md | 4 ++++ docs/client_api/l2cache.md | 17 +++++++---------- docs/client_api/materialize.md | 18 +++++++----------- docs/client_api/state.md | 18 +++++++----------- 5 files changed, 32 insertions(+), 43 deletions(-) diff --git a/docs/client_api/chunkedgraph.md b/docs/client_api/chunkedgraph.md index a4494244..25c641f8 100644 --- a/docs/client_api/chunkedgraph.md +++ b/docs/client_api/chunkedgraph.md @@ -2,17 +2,13 @@ title: client.chunkedgraph --- -Note: the functionality described here will be accurate if the datastack you are using -is using the most up-to-date version of the chunkedgraph engine. If something seems -wrong with the documentation here, try checking the version of the chunkedgraph -engine returned by your client: - -```python -type(client.chunkedgraph) -``` - -Extended documentation for all versions of the chunkedgraph client can be found -[here](../extended_api/chunkedgraph.md). +!!! note + The functionality described here will be accurate if the datastack you are using is using the most up-to-date version of the chunkedgraph service. If something seems wrong with the documentation here, try checking the version of the chunkedgraph returned by your client: + ```python + type(client.chunkedgraph) + ``` + Extended documentation for all versions of the chunkedgraph client can be found + [here](../extended_api/chunkedgraph.md). ::: caveclient.chunkedgraph.ChunkedGraphClientV1 options: diff --git a/docs/client_api/index.md b/docs/client_api/index.md index 9c6b02bc..5e2090cb 100644 --- a/docs/client_api/index.md +++ b/docs/client_api/index.md @@ -8,3 +8,7 @@ services. Under the hood, the CAVEclient is a collection of individual clients, can be accessed via properties. For example, to access the materialization client, you can use `client.materialize`, which (up to the exact version) will actually return a [caveclient.materializationengine.MaterializatonClientV3][] object. + +These pages describe the functionality of each of the individual clients, assuming +that you are using the most up-to-date version of each. For more detailed information +on all versions of all clients available, visit the [extended API documentation](../extended_api/index.md). diff --git a/docs/client_api/l2cache.md b/docs/client_api/l2cache.md index b99bd658..5b5c3722 100644 --- a/docs/client_api/l2cache.md +++ b/docs/client_api/l2cache.md @@ -2,16 +2,13 @@ title: client.l2cache --- -Note: the functionality described here will be accurate if the datastack you are using -is using the most up-to-date version of the level-2 cache. If something seems -wrong with the documentation here, try checking the version of the level-2 cache returned by your client: - -```python -type(client.l2cache) -``` - -Extended documentation for all versions of the level-2 cache client can be found -[here](../extended_api/l2cache.md). +!!! note + The functionality described here will be accurate if the datastack you are using is using the most up-to-date version of the L2 cache. If something seems wrong with the documentation here, try checking the version of the L2 cache returned by your client: + ```python + type(client.l2cache) + ``` + Extended documentation for all versions of the L2 cache client can be found + [here](../extended_api/l2cache.md). ::: caveclient.l2cache.L2CacheClientLegacy options: diff --git a/docs/client_api/materialize.md b/docs/client_api/materialize.md index 0eab42df..dd605f98 100644 --- a/docs/client_api/materialize.md +++ b/docs/client_api/materialize.md @@ -2,17 +2,13 @@ title: client.materialize --- -Note: the functionality described here will be accurate if the datastack you are using -is using the most up-to-date version of the materialization engine. If something seems -wrong with the documentation here, try checking the version of the materialization -engine returned by your client: - -```python -type(client.materialize) -``` - -Extended documentation for all versions of the materialization client can be found -[here](../extended_api/materialization.md). +!!! note + The functionality described here will be accurate if the datastack you are using is using the most up-to-date version of the materialization engine. If something seems wrong with the documentation here, try checking the version of the materialization client returned by your client: + ```python + type(client.materialize) + ``` + Extended documentation for all versions of the annotation client can be found + [here](../extended_api/materializationengine.md). ::: caveclient.materializationengine.MaterializatonClientV3 options: diff --git a/docs/client_api/state.md b/docs/client_api/state.md index 018ba39c..ad341e35 100644 --- a/docs/client_api/state.md +++ b/docs/client_api/state.md @@ -2,17 +2,13 @@ title: client.state --- -Note: the functionality described here will be accurate if the datastack you are using -is using the most up-to-date version of the state engine. If something seems -wrong with the documentation here, try checking the version of the state -engine returned by your client: - -```python -type(client.state) -``` - -Extended documentation for all versions of the state client can be found -[here](../extended_api/state.md). +!!! note + The functionality described here will be accurate if the datastack you are using is using the most up-to-date version of the JSON state service. If something seems wrong with the documentation here, try checking the version of the JSON state service returned by your client: + ```python + type(client.state) + ``` + Extended documentation for all versions of the state client can be found + [here](../extended_api/jsonservice.md). ::: caveclient.jsonservice.JSONServiceV1 options: