openzim / openzim/python-libzim
Remove private prefix of `Archive._get_entry_by_id`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 108
- Forks
- 29
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 1
Description
Archive._get_entry_by_id() has been there, prefixed, since the beginning of the wrapper.
We now has enough experience to say that it serves some use cases that are not served by other means, including #94.
It's true that it is not common to use it, but so are many parts of the API.
We should thus remove the prefix (and keep a deprecated alias until next major)
See #224
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching the Python binding for Archive._get_entry_by_id() and review the related context in issues #224 and #94. Done means the entry point is available without the private prefix while the existing name remains as a deprecated alias until the next major release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100