docs: use indices instead of indexes in guide and quickstart - #8399
Merged
Conversation
`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.
Xuanwo
approved these changes
Aug 7, 2026
Contributor
Author
|
Thanks @Xuanwo |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AGENTS.mdasks forindices(notindexes) consistently in APIs and docs.These five occurrences are all prose about index objects, so the rule applies
directly.
Left alone:
maintained_indexesindataset.py, which matches the field namein
python/src/dataset.rsandmem_wal/api.rs— renaming it on the Pythonside only would break the stronger cross-language naming rule.