Skip to content

Clarify the forEachSlice callback in the Indexes API docs #304

Description

@dajiaohuang

Problem

The Indexes.forEachSlice API page describes the wrong callback in its prose. On v9.7.0 (f09e5a3b74ea16b6fac93439be34cc3f954f1e7c), the generated page says that the rowCallback parameter is a RowCallback called with a row Id and value. The method signature and example show that the parameter is sliceCallback: SliceCallback, called with a slice Id and a forEachRow iterator.

Evidence

Please change the prose to describe sliceCallback and its row iterator, so readers are not led to look for a row-value callback that this API does not provide.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions