Description
I noticed an inconsistency between the documentation and the actual implementation regarding the Imagick::destroy() method, and I wanted to ask the community about the intended direction.
Current Situation
- The documentation states that
Imagick::destroy() is deprecated and recommends using clear() instead
- However, in the actual codebase,
destroy() appears to be simply defined as an alias to clear() without any deprecation markers
- This same pattern exists for similar classes like
ImagickDraw and ImagickPixel
My Question
I'm wondering what the intended direction is for these methods:
- If deprecation is intended, would it make sense to add proper deprecation markers in the code (e.g., using
IMAGICK_METHOD_DEPRECATED_USE_INSTEAD) to match the documentation?
- Or, if there's no strong intent to deprecate them, would it be appropriate to update the documentation to simply note they're aliases rather than deprecated methods?
I personally find the destroy() method name clear and intuitive, and since it's just an alias with no functional issues, I'm inclined to think updating the documentation might be simpler. But I'm new to contributing here and would love to hear the community's thoughts and understand the historical context better.
If there's consensus on a direction, I'd be happy to help with a PR.
Description
I noticed an inconsistency between the documentation and the actual implementation regarding the
Imagick::destroy()method, and I wanted to ask the community about the intended direction.Current Situation
Imagick::destroy()is deprecated and recommends usingclear()insteaddestroy()appears to be simply defined as an alias toclear()without any deprecation markersImagickDrawandImagickPixelMy Question
I'm wondering what the intended direction is for these methods:
IMAGICK_METHOD_DEPRECATED_USE_INSTEAD) to match the documentation?I personally find the
destroy()method name clear and intuitive, and since it's just an alias with no functional issues, I'm inclined to think updating the documentation might be simpler. But I'm new to contributing here and would love to hear the community's thoughts and understand the historical context better.If there's consensus on a direction, I'd be happy to help with a PR.