developmentseed / developmentseed/zarrista

Rename the `Array.read_only` method?

Open
#163 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
45
Forks
2
Avg merge
2d 4h
Merged PRs (30d)
7

Description

`Array.read_only` _looks_ like a boolean predicate, asking whether the current array is read-only or not.

_Instead_ it's a _method_ that converts the current array into a read-only array.

```
def read_only(self) -> Array: # returns an Array
def is_sharded(self) -> bool: # actual predicate, same class
```

I'll leave this as-is for 0.1 and we can come back to discuss

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the Array.read_only method and the nearby is_sharded method to compare their naming and behavior. Confirm whether a replacement name is agreed on and check the API implications before making any change; done means the conversion method has an unambiguous non-predicate name and existing callers remain consistent.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.