openzim / openzim/python-scraperlib

[next major] Remove deprecated 'convert' parameter for optimize_image function inside optimization.py

Open Beginner friendly
#292 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
31
Forks
27
Avg merge
3d 7h
Merged PRs (30d)
2

Description

Once #289 gets merged, the convert parameter will be deprecated and should be removed as the conversion happens automatically inside each optimize_xxx method. We no longer need to pass the dst format string via convert parameter. Users should use the parameter dst_format instead to pass the dst format.

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

After #289 is merged, start in optimization.py at optimize_image and trace its callers and tests. Replace uses of the deprecated convert parameter with dst_format where needed, then verify that conversion remains handled by each optimize_xxx method and that the affected tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
performance
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.