Skip to content

saddle-points: Reconcile 1-based indices in README with 0-based indices in tests #791

@petertseng

Description

@petertseng

exercism/problem-specifications#1429 which was applied to this track in #789 uses one-based indices in the https://github.com/exercism/rust/blob/master/exercises/saddle-points/README.md. The track still uses zero-based indices in the https://github.com/exercism/rust/tree/master/exercises/saddle-points/tests . This inconsistency is a potential source of student confusion.

Various solutions:

  1. Change the tests to be one-indexed.
  2. Maintain our own README with zero-based indices. You do this by placing the README we want in .meta/description.md. Not recommended.
    • We cannot just use hints.md since that only allows additive changes. This is a modification of existing text, which hints.md does not support.
  3. Keep both the README and tests as is, but insert a statement somewhere telling students to be aware of the discrepancy.
  4. Suggest to problem-specifications that no, really, they should go back to using zero-based indices.
  5. Your suggestion here.

I do not recommend 2 (maintain our own README) so if you want to go this route you have to convince me why we should be in the business of maintaining our own READMEs.

I have no specific preferences or recommendations between any of the other options.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueAn improvement or bug fix that favors new contributors

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions