Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the createThumbs function in the image class #352

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

laoneo
Copy link
Member

@laoneo laoneo commented Dec 23, 2024

User description

joomla/joomla-cms#44663


PR Type

Documentation


Description

  • Added migration documentation for the removal of createThumbs function from the Image class
  • Provided clear code examples demonstrating how to migrate from createThumbs to createThumbnails
  • Updated backward compatibility documentation to help users update their code

Changes walkthrough 📝

Relevant files
Documentation
removed-backward-incompatibility.md
Document Image class API change for thumbnail creation     

migrations/54-60/removed-backward-incompatibility.md

  • Added documentation about the removal of createThumbs function from
    Image class
  • Provided code examples showing migration from createThumbs to
    createThumbnails
  • +15/-0   

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Enhance migration documentation by highlighting breaking changes and providing guidance for identifying affected code

    Add a note about potential breaking changes and provide guidance on how to check for
    usage of the deprecated function in existing code bases.

    migrations/54-60/removed-backward-incompatibility.md [72]

    -- Description: The `createThumbs` function in the `Image` class got removed as the function `createThumbnails` should be used instead. For example you can use
    +- Description: The `createThumbs` function in the `Image` class got removed as the function `createThumbnails` should be used instead. This is a breaking change that requires updating existing code. To find affected code, search for `createThumbs` method calls on `Image` objects. For example you can use:
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The suggestion significantly improves the migration documentation by explicitly warning about breaking changes and providing practical guidance for identifying affected code, which is crucial for users upgrading their codebase.

    8

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant