Skip to content

Commit 90c8675

Browse files
everettVTclaude
andauthored
fix(docs): Fix broken links in modalities documentation (#6197)
## Summary - Fix 15 broken documentation links across `files.md`, `audio.md`, `videos.md`, and `embeddings.md` - Links pointed to non-existent pages under `api/functions/` and `api/io/` subdirectories - Redirected to correct existing pages (`api/io.md`, `api/expressions.md`, `api/datatypes/file_types.md`, `api/datatypes/all_datatypes.md`, `api/ai.md`, `custom-code/func.md`, `custom-code/cls.md`) ## Test plan - [x] `make format` passes - [x] `make lint` passes - [x] `make precommit` passes (all 21 hooks) - [x] `make docs` builds with no broken link warnings from modified files - [x] `make doctests` passes (274 tests) 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent dde58b6 commit 90c8675

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/modalities/embeddings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Embeddings transform text, images, and other data into dense vector representations that capture semantic meaning—enabling similarity search, retrieval-augmented generation (RAG), and AI-powered discovery. Daft makes it easy to generate, store, and query embeddings at scale.
44

5-
With the native [`daft.DataType.embedding`](../api/datatypes/embedding.md) type and [`embed_text`](../api/functions/embed_text.md) function, you can:
5+
With the native [`daft.DataType.embedding`](../api/datatypes/all_datatypes.md#daft.datatype.DataType.embedding) type and [`embed_text`](../api/functions/embed_text.md) function, you can:
66

77
- **Generate embeddings** from any text column using providers like OpenAI, Cohere, or local models
88
- **Compute similarity** with built-in distance functions like `cosine_distance`

docs/modalities/files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Whether you're loading data from local files, cloud storage, or the web, Daft's
1414

1515
## Using file discovery with optimized distributed reads
1616

17-
[`daft.from_glob_path`](../api/io/file_path.md) helps discover and size files, accepting wildcards and lists of paths. When paired with [`daft.functions.download`](../api/functions/download.md), the two functions enable optimized distributed reads of binary data from storage. This is ideal when your data will fit into memory or when you need the entire file content at once.
17+
[`daft.from_glob_path`](../api/io.md#daft.from_glob_path) helps discover and size files, accepting wildcards and lists of paths. When paired with [`daft.functions.download`](../api/functions/download.md), the two functions enable optimized distributed reads of binary data from storage. This is ideal when your data will fit into memory or when you need the entire file content at once.
1818

1919
=== "🐍 Python"
2020
``` python
@@ -141,7 +141,7 @@ This architecture allows us to implement storage-specific optimizations (like ne
141141
2. Optimized backend readers for different sources (buffered network access, etc.)
142142
3. Consistent API regardless of storage location
143143

144-
`daft.File` mirrors the [file interface in Python](https://docs.python.org/3/library/functions.html#open), but is optimized for distributed computing. Due to its lazy nature, `daft.File` does not read the file into memory until it is needed. To enforce this pattern, `daft.File` must be used inside a context manager like `with file.open() as f:` This works within a [`daft.func`](../api/custom-code/func.md) or [`daft.cls`](../api/custom-code/cls.md) user-defined functions or in native Python code.
144+
`daft.File` mirrors the [file interface in Python](https://docs.python.org/3/library/functions.html#open), but is optimized for distributed computing. Due to its lazy nature, `daft.File` does not read the file into memory until it is needed. To enforce this pattern, `daft.File` must be used inside a context manager like `with file.open() as f:` This works within a [`daft.func`](../custom-code/func.md) or [`daft.cls`](../custom-code/cls.md) user-defined functions or in native Python code.
145145

146146
## Basic Usage
147147

docs/modalities/videos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ There are two main ways to work with videos in Daft:
66

77
`daft.VideoFile` is a subclass of `daft.File` that provides a specialized interface for video-specific operations.
88

9-
- [daft.read_video_frames](../api/functions/read_video_frames.md) for reading video frames into a DataFrame
9+
- [daft.read_video_frames](../api/io.md#daft.read_video_frames) for reading video frames into a DataFrame
1010
- [daft.VideoFile](../api/datatypes/file_types.md) for working with video files
1111
- [daft.functions.video_file](../api/functions/video_file.md) for working with video files
1212
- [daft.functions.video_metadata](../api/functions/video_metadata.md) for working with video metadata

0 commit comments

Comments
 (0)