Skip to content

docs: Say what correct can and can't repair #89

Description

@BenWestgate

The user guide gives correct one paragraph. The limits are only in the developer API guide, under "BCH and bounded structural correction". A tester called correction "a black box".

Add a paragraph to the user guide that says what one string can survive and what it can't. This starting list must be checked against the tests before it is published:

  • up to 4 wrong characters, up to 8 unreadable ? characters, or 13 consecutive unreadable characters (15 for long strings);
  • two whole four-character groups deleted, added or swapped, or 5–8 errors inside two groups;
  • 3–4 missing characters, 4 extra characters, 2 missing plus 2 extra, or 3 missing plus 1 extra;
  • in every case except two missing or wrong groups, some leftover wrong or unreadable characters as well.

It can't repair more than 13 missing characters. Filling exactly 13 unreadable characters always produces a valid string, but that string is wrong if any other character was mistyped. The tester ran into exactly this case.

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

    area: correctionCorrection engine and correction UX.documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions