search

status-im / status-go

The Status module that consumes go-ethereum
https://status.im
Mozilla Public License 2.0
727 stars 245 forks source link

Remove / Redo: `image-center-crop-calculations.png` #5233

Open supragya opened 3 months ago

supragya commented 3 months ago

Problem

Nothing major, was going through _docs and found https://github.com/status-im/status-go/blob/develop/_docs/image-center-crop-calculations.png. This seems to be calculations for some UX and is 3 years old. It is unclear why it exists there and how it is connected to other elements in _docs. Prefer removing it?

It is used in docstring for:

func CropCenter(img image.Image) (image.Image, error)

in manipulation.go. Would recommend clean-up still.

Implementation

One of two options:

  1. func CropCenter(...) isn't too involved in itself. The current comment does a fairly good job explaining the intention of deriving the "centre square". Hence, the image reference is not needed at all.
  2. If at all the reference is needed, prefer a cleaner version uploaded in place.

Acceptance Criteria

-NA-

Notes

-NA-

Future Steps

-NA-

supragya commented 3 months ago

I would like to provide a quick PR fix is core devs want :)