Skip to content

docs: use indices instead of indexes in guide and quickstart - #8399

Merged
Xuanwo merged 1 commit into
lance-format:mainfrom
jackylee-ch:docs/indices-not-indexes
Aug 7, 2026
Merged

docs: use indices instead of indexes in guide and quickstart#8399
Xuanwo merged 1 commit into
lance-format:mainfrom
jackylee-ch:docs/indices-not-indexes

Conversation

@jackylee-ch

Copy link
Copy Markdown
Contributor

AGENTS.md asks for indices (not indexes) consistently in APIs and docs.
These five occurrences are all prose about index objects, so the rule applies
directly.

Left alone: maintained_indexes in dataset.py, which matches the field name
in python/src/dataset.rs and mem_wal/api.rs — renaming it on the Python
side only would break the stronger cross-language naming rule.

`AGENTS.md` asks for `indices` (not `indexes`) consistently in APIs and docs.
These five occurrences are all prose about index objects.

Leaves `maintained_indexes` in `dataset.py` alone: it matches the field name
in `python/src/dataset.rs`, so renaming it on the Python side only would break
the cross-language naming rule.
@github-actions github-actions Bot added A-docs Documentation documentation Improvements or additions to documentation labels Aug 7, 2026

@lance-gatekeeper lance-gatekeeper Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gate recommendation: approve.

The prose-only replacements follow the repository terminology contract without changing code examples, APIs, links, or document structure.

@Xuanwo
Xuanwo merged commit 6f3984f into lance-format:main Aug 7, 2026
6 checks passed
@jackylee-ch

Copy link
Copy Markdown
Contributor Author

Thanks @Xuanwo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-docs Documentation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants