Skip to content

[5.2] radio basic deprecate #43860#298

Merged
Hackwar merged 2 commits intojoomla:mainfrom
brianteeman:patch-1
Aug 25, 2024
Merged

[5.2] radio basic deprecate #43860#298
Hackwar merged 2 commits intojoomla:mainfrom
brianteeman:patch-1

Conversation

@brianteeman
Copy link
Contributor

@brianteeman brianteeman commented Aug 16, 2024

PR Type

documentation


Description

  • Added a deprecation notice for the RadiobasicField in the migration guide.
  • Provided context with references to related PR and issue.
  • Outlined the deprecation timeline: deprecated in 5.x, moved to b/c plugin in 6.0, and removed in 7.0.

Changes walkthrough 📝

Relevant files
Documentation
new-deprecations.md
Document deprecation of `RadiobasicField` in migration guide

migrations/51-52/new-deprecations.md

  • Added deprecation notice for RadiobasicField.
  • Included PR and issue references for context.
  • Detailed the timeline for deprecation and removal.
  • +6/-0     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @qodo-code-review qodo-code-review bot added the documentation Improvements or additions to documentation label Aug 16, 2024
    @qodo-code-review
    Copy link
    Contributor

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

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

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Aug 16, 2024

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    ✅ Correct a typographical error in the description
    Suggestion Impact:The suggestion to fix the typo "and and" was implemented, improving the readability of the documentation.

    code diff:

    -Description: Based on the Issue #19299 and and PR #19320 the radiobasic field is pretty useless and can be removed.
    +Description: Based on the Issue #19299 and PR #19320 the radiobasic field is pretty useless and can be removed.

    Fix the typo in "and and" to improve readability and professionalism of the
    documentation.

    migrations/51-52/new-deprecations.md [33]

    -Description: Based on the Issue #19299 and and PR #19320 the radiobasic field is pretty useless and can be removed.
    +Description: Based on the Issue #19299 and PR #19320 the radiobasic field is considered unnecessary and can be removed.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: Fixing the typo "and and" is a straightforward correction that improves the professionalism and readability of the documentation, making it a high-priority fix.

    9
    Enhancement
    Add a clear deprecation timeline for the RadiobasicField

    Consider adding more specific information about the deprecation timeline for the
    RadiobasicField. Include the version numbers for when it will be deprecated, moved
    to the b/c plugin, and finally removed.

    migrations/51-52/new-deprecations.md [30-34]

     ### RadiobasicField
     
     PR: https://github.com/joomla/joomla-cms/pull/43860
    -Description: Based on the Issue #19299 and and PR #19320 the radiobasic field is pretty useless and can be removed.
    -Decision in the maintainer meeting we deprecate the field in 5.x and move it to the b/c plugin in 6.0 and remove it in 7.0.
    +Description: Based on the Issue #19299 and PR #19320 the radiobasic field is considered unnecessary and will be deprecated.
    +Deprecation timeline:
    +- Deprecated in Joomla 5.x
    +- Moved to the b/c plugin in Joomla 6.0
    +- Removed in Joomla 7.0
     
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: The suggestion improves clarity by explicitly listing the deprecation timeline, which enhances the documentation's readability and helps users understand the changes better.

    7
    Provide more context and rationale for the RadiobasicField deprecation

    Provide more context about the RadiobasicField, such as its current usage or why
    it's considered unnecessary, to help users understand the rationale behind its
    deprecation.

    migrations/51-52/new-deprecations.md [30-34]

     ### RadiobasicField
     
     PR: https://github.com/joomla/joomla-cms/pull/43860
    -Description: Based on the Issue #19299 and and PR #19320 the radiobasic field is pretty useless and can be removed.
    -Decision in the maintainer meeting we deprecate the field in 5.x and move it to the b/c plugin in 6.0 and remove it in 7.0.
    +Description: The RadiobasicField, which provides basic radio button functionality, is being deprecated due to limited use cases and redundancy with other form field types. Based on Issue #19299 and PR #19320, it has been determined that this field type is unnecessary and can be safely removed.
    +Current usage: [Brief explanation of where it's currently used, if applicable]
    +Alternative: [Suggest alternative field types that can be used instead]
    +Decision: In the maintainer meeting, it was decided to deprecate the field in 5.x, move it to the b/c plugin in 6.0, and remove it in 7.0.
     
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: While providing additional context and rationale is beneficial for understanding the deprecation decision, the suggestion is not crucial and could be considered optional, thus receiving a moderate score.

    6

    @Hackwar Hackwar merged commit 7fbe363 into joomla:main Aug 25, 2024
    @brianteeman brianteeman deleted the patch-1 branch August 25, 2024 20:49
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    documentation Improvements or additions to documentation Review effort [1-5]: 1

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants