LiveSplit / LiveSplit/livesplit-core

Rework Run::current_split_index

Open
#266 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code quality enhancement needs further discussion priority: low
Dominant language
Rust
Stars
227
Forks
81
Avg merge
22h 45m
Merged PRs (30d)
3

Description

It should either return None or a valid index into the Run. I don't think it's a good idea that we are returning out of bounds indices here. @wooferzfg thoughts?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Run::current_split_index implementation and inspect its callers to understand the expected index semantics. Resolve whether the method should return None or a valid Run index, then verify that it never returns an out-of-bounds value.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.