Skip to content

Commit 6fb0180

Browse files
committed
Update docs
1 parent f82460f commit 6fb0180

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

Diff for: docs/api/api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ The [`weco`](../index.md) package offers two modes of interacting with the AI fu
44

55
| Submodule | Description | Use Cases |
66
| --- | --- | --- |
7-
| [`weco.WecoAI`](client.md) | WeCo AI client to build and query functions synchronously, asynchronously and in batches. | - Dense service usage<br>- Maintaing the same client instance over large portions of code |
8-
| [`weco.functional`](functional.md) | Functional form of WeCo AI client offering the same features as `weco.WecoAI`. | - Sparse service usage<br>- Quick prototyping |
7+
| [`weco.WecoAI`](client.md) | Weco AI client to build and query functions synchronously, asynchronously and in batches. | - Dense service usage<br>- Maintaing the same client instance over large portions of code |
8+
| [`weco.functional`](functional.md) | Functional form of Weco AI client offering the same features as `weco.WecoAI`. | - Sparse service usage<br>- Quick prototyping |

Diff for: docs/api/client.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
:::weco.client.WecoAI
1+
:::weco.client

Diff for: docs/api/functional.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
:::weco.functional

Diff for: docs/cookbook/cookbook.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Getting Started
66

7-
`weco` is a client facing API for interacting with the [WeCo AI](https://www.weco.ai/) function builder [service](https://weco-app.vercel.app/function). Use this API to build *complex* systems *fast*!
7+
`weco` is a client facing API for interacting with the [Weco AI](https://www.weco.ai/) function builder [service](https://weco-app.vercel.app/function). Use this API to build *complex* systems *fast*!
88

99
Here are a few features our users often ask about. Feel free to follow along:
1010

Diff for: mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ plugins:
7474
python:
7575
paths: [weco]
7676
options:
77+
docstring_style: numpy
78+
separate_signature: true
79+
show_signature_annotations: false
7780
show_source: false
7881
heading_level: 2
7982

0 commit comments

Comments
 (0)