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

Changes for MDL-80677 #868

Merged
merged 4 commits into from
Mar 13, 2024
Merged

Changes for MDL-80677 #868

merged 4 commits into from
Mar 13, 2024

Conversation

andrewnicols
Copy link
Member

No description provided.

Copy link

netlify bot commented Jan 18, 2024

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit bcec4ae
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/65ef14a4c24d9700081dc7ff
😎 Deploy Preview https://deploy-preview-868--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.

Copy link
Contributor

github-actions bot commented Jan 18, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 50 🟠 87 🟢 92 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 70 🟠 85 🟢 92 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 80 🟠 87 🟢 92 🟢 90 🟢 100 Report
/general/releases 🟠 65 🟠 87 🟢 92 🟢 100 🟢 100 Report

Copy link
Collaborator

@junpataleta junpataleta left a comment

Choose a reason for hiding this comment

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

Thanks, Andrew! This looks good to me overall.

Should we also update the Deprecation policy to provide information on using the core/deprecated attribute and core/deprecation during initial and final deprecation?

@andrewnicols
Copy link
Member Author

I considered this but I don't know. It's not intended to replace the current deprecation, but to aid it. Maybe a note like:

:::note

From Moodle 4.4 onwards, you may wish to use the `\core\deprecated` attribute in combination with the `\core\deprecation` class to emit this message.

:::

@timhunt
Copy link
Collaborator

timhunt commented Jan 18, 2024

The buggest problem with Moodle deprectation messages is that people tell you to stop doing something without telling you what to do instead.

If what to do instead is not requred information, this is moving deckchairs on the Titanic. Certainly, all the give examples in the new docs should set a good example "reason: 'No longer required'," is so bad, it is basically a parody, right?

@andrewnicols
Copy link
Member Author

Thanks for the feedback Tim.

I thought about making this a required field, but there is not always a replacement. Sometimes things are just removed and that should be mentioned in the reason.

Do you have a better suggestion on how we can do this?

@timhunt
Copy link
Collaborator

timhunt commented Jan 19, 2024

When you say "I thought about making this a required field, but there is not always a replacement. Sometimes things are just removed and that should be mentioned in the reason." you are thinking about things from the wrong angle.

Think about things from the point of view as a plugin developer.

You don't just call Moodle core APIs for a laugh. Any time you are calling a core API, an you are trying to achieve some end goal on behalf of the user.

Generally, Moodle does not make it impossible to do things that were possible in the past. There must always be some sort of new recommended way to do thin thing that you were doing the old way.

Anyway, when you make an API change that broke my plugin, I don't really care why you thought it was a good idea. I just want to know what I should do now in my code. So, that should be the required information.

@andrewnicols andrewnicols changed the title Changes for MDL-80005 Changes for MDL-80677 Feb 19, 2024
@sarjona sarjona added blocked-by-tracker This issue is blocked by an issue in https://tracker.moodle.org/ and removed waiting-for-feedback labels Feb 27, 2024
@junpataleta junpataleta added this pull request to the merge queue Mar 13, 2024
Merged via the queue into moodle:main with commit 598bd1c Mar 13, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked-by-tracker This issue is blocked by an issue in https://tracker.moodle.org/
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants