bp / bp/resqpy

Switch "array_ref" and similar method names to "values"

Open
#98 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
67
Forks
18
Avg merge
2h 26m
Merged PRs (30d)
1

Description

Several resqpy methods cache and return an array of values. At the moment such methods typically have names ending "...ref" as a reminder that the resqpy object is holding on to a handle and that a new copy of the array will not be made if the method is called repeatedly.

It is suggested that such methods are renamed simply as "values" to be more consistent with some other packages.

Contributor guide

Open the contributing guide

Research direction

No files or tests are identified. Start by inventorying resqpy methods whose names end in “ref” and cache or return arrays, then review their callers and existing naming patterns. Done means the affected methods consistently use “values” names.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.