eclipse-score / eclipse-score/lifecycle

Clean up SafeProcessMap

Open
#245 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
6
Forks
34
Avg merge
2d 3h
Merged PRs (30d)
80

Description

### What

The current `SafeProcessMap` is very confusing to read.

* method names are lying.
* e.g. search is actually a replace.
* there are docs strings that explain the internal logic instead of the outcome, making it brittle (it seems this is already outdated?)
* we return enums/ints and modify an out parameter instead of using results.

### Acceptance Criteria (DoD)

* Method names correctly describe what they do.
* Doc strings match what methods do without over-explaining.
* Think about using types that would guarantee a user has to do error checking.

### How

_No response_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.