Skip to content

Commit

Permalink
add notes
Browse files Browse the repository at this point in the history
  • Loading branch information
bdpedigo committed Jan 19, 2024
1 parent 886860e commit 5fa2652
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 43 deletions.
18 changes: 7 additions & 11 deletions docs/client_api/chunkedgraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions docs/client_api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
17 changes: 7 additions & 10 deletions docs/client_api/l2cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 7 additions & 11 deletions docs/client_api/materialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
18 changes: 7 additions & 11 deletions docs/client_api/state.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 5fa2652

Please sign in to comment.