Skip to content

[Doc Review] retake should be rescan in MRZResultViewToolbarButtonsConfig #46

@Tom-Dynamsoft

Description

@Tom-Dynamsoft

Documentation Issue: retake should be rescan in MRZResultViewToolbarButtonsConfig

Category: Accuracy
Severity: Error
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: A2, A10, A11

Problem

The MRZResultViewToolbarButtonsConfig interface uses a property named retake throughout the docs, but the actual SDK source defines it as rescan. This mismatch appears in three locations.

Locations

  1. api/mrz-scanner.md — MRZResultViewToolbarButtonsConfig syntax block and properties table
  2. api/mrz-scanner.md — MRZResultViewConfig example (line ~289)
  3. guides/mrz-scanner-customization.md — MRZResultViewConfig example (line ~203)

Expected (from source)

interface MRZResultViewToolbarButtonsConfig {
  cancel?: ToolbarButton;
  rescan?: ToolbarButtonConfig;
  done?: ToolbarButtonConfig;
}

Actual (in docs)

interface MRZResultViewToolbarButtonsConfig {
  retake?: ToolbarButtonConfig;
  done?: ToolbarButtonConfig;
  cancel?: ToolbarButtonConfig;
}

Recommended Fix

Replace retake with rescan in all three locations: the syntax block, the properties table, and all code examples.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationreview-findingFinding from automated documentation review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions