Skip to content

Conversation

@andrewnicols
Copy link
Member

No description provided.

@netlify
Copy link

netlify bot commented Apr 3, 2025

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit 3ac272a
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/67f5ddfec02f080008edc66d
😎 Deploy Preview https://deploy-preview-1315--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@andrewnicols andrewnicols requested a review from Copilot April 3, 2025 03:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the deprecation policy documentation to clearly outline the final removal process with improved structure and examples.

  • Clarified conditions for deprecations on the main branch
  • Revised formatting and phrasing for deprecation steps and code examples
  • Added a new section detailing the removal process

@andrewnicols andrewnicols requested a review from timhunt April 3, 2025 03:38
@andrewnicols andrewnicols force-pushed the deprecationRemovalsAndClarifications branch from 34c8e5f to 114d779 Compare April 3, 2025 03:39
@andrewnicols andrewnicols requested a review from Copilot April 3, 2025 03:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the deprecation policy documentation to clearly outline the process for final removal of deprecated features. Key changes include:

  • Expanded details on when deprecations can be applied, including exceptions for external integrations, irreparable feature breaks, and security issues.
  • Revised and restructured examples demonstrating both debugging and deprecation API usage.
  • Clarified the removal process with a new Step 3 section and modified guidelines on handling function versus method signatures.
Comments suppressed due to low confidence (1)

general/development/policies/deprecation/index.md:172

  • [nitpick] There appears to be a distinction between method signatures and function signatures in this section. It would help to add additional clarification to explain why function signatures may be removed while method signatures must remain unchanged.
Method signatures **must not change**, that is:

@andrewnicols andrewnicols force-pushed the deprecationRemovalsAndClarifications branch from 114d779 to 17ec0bb Compare April 3, 2025 03:47
@andrewnicols andrewnicols requested a review from Copilot April 3, 2025 03:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the deprecation policy documentation to clarify the final removal process and refine guidelines surrounding deprecation stages and method/function signature changes. Key changes include:

  • Splitting deprecation into three clear stages (Initial deprecation, Final deprecation, and Removal).
  • Updating tabbed examples and code snippets for both debugging notices and the \core\deprecation API.
  • Revising the policy on method versus function signature changes with an accompanying explanatory info section.

Copy link
Collaborator

@timhunt timhunt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for donig this Andrew. Good to get this written down, and generally very good.

Just two bits of quibbling from me, and one from Jun, then this can move forwards.

@andrewnicols andrewnicols force-pushed the deprecationRemovalsAndClarifications branch from 17ec0bb to 3ac272a Compare April 9, 2025 02:39
@andrewnicols
Copy link
Member Author

Thanks both,

I've updated the text for those points.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

general/development/policies/deprecation/index.md:160

  • [nitpick] The relabeling and ordering of the TabItems between the 'core_deprecation' and 'debugging' examples appear inconsistent compared to the previous version. Please verify that each tab is correctly named and placed to avoid confusion.
+<TabItem value="debugging" label="Deprecations using debugging">

Copy link
Collaborator

@timhunt timhunt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now. Thanks Andrew.

@andrewnicols andrewnicols enabled auto-merge April 22, 2025 06:07
@andrewnicols andrewnicols added this pull request to the merge queue Apr 22, 2025
Merged via the queue into moodle:main with commit b9b6e5a Apr 22, 2025
6 checks passed
@andrewnicols andrewnicols deleted the deprecationRemovalsAndClarifications branch April 22, 2025 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants