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

Deprecations from #40613 added functionality #364

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Bodge-IT
Copy link

@Bodge-IT Bodge-IT commented Jan 11, 2025

User description

Two methods modified and deprecated to facilitate new changes.
PR #40613 as reference.


PR Type

Documentation, Enhancement


Description

  • Documented deprecation of postProcessStore and batchTag methods.

  • Introduced preferred methods postStore and batchTags for better functionality.

  • Highlighted removal timeline for deprecated methods (5.3 to 7.0).

  • Linked PR #40613 as reference for changes.


Changes walkthrough 📝

Relevant files
Documentation
new-deprecations.md
Document deprecations and preferred methods in migration guide

migrations/52-53/new-deprecations.md

  • Added documentation for deprecating postProcessStore and batchTag.
  • Introduced postStore and batchTags as preferred methods.
  • Provided code examples for new methods.
  • Linked PR #40613 for reference.
  • +23/-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
    ⚡ Recommended focus areas for review

    Documentation Clarity

    The documentation should clarify whether the new methods maintain backwards compatibility with the old ones, and provide more details about any behavioral changes between old and new methods

    ``` new postStore()
        public function postStoreProcess(TableInterface $table, $newTags = [], $replace = true)
        {
            $this->postStore($table, $newTags, $replace);
        }

    postStoreProcess() replaced by postStore() preferred method, adds TableInterface to method.

        protected function batchTag($value, $pks, $contexts)
        {
            return $this->batchTags($value, $pks, $contexts);
        }
    

    batchTag() method replaced with batchTags preferred method providing more accurate descriptive title.

    
    </details>
    
    </td></tr>
    </table>
    

    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 ✨

    No code suggestions found for the PR.

    @HLeithner
    Copy link
    Member

    I changed some text, but would wait with the merge if we get better typehinting

    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.

    2 participants