Skip to content

Commit 784b794

Browse files
committed
Merge branch 'timhunt-patch-1'
2 parents b79eea3 + a1de17e commit 784b794

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

general/community/meetings/2024/05.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ sidebar_position: -05
1717
1. [Moodle Developer Experience (DX) update](./_files/2024-05-DX-presentation.pdf)
1818
[Andrew Lyons](https://moodle.org/user/profile.php?id=268794) Moodle HQ
1919
- Changes to [Moodle Versioning and Deprecation policies](https://moodle.org/mod/forum/discuss.php?d=457946)
20-
- Writing upgrade notes for Moodle 4.5 and up (MDL-81125 | [Discussion](https://moodle.org/mod/forum/discuss.php?d=457756))
20+
- [Writing upgrade notes for Moodle 4.5 and up](../../../development/upgradenotes). (Added in MDL-81125 | See also [this discussion](https://moodle.org/mod/forum/discuss.php?d=457756))
2121
- Coding Style and [MoodleCS](../../../development/tools/phpcs.md)
2222
- Dependency Injections
2323
- Hooks

general/development/upgradenotes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ From Moodle 4.5 a new tool, `upgradenotes` has been created to help improve upgr
2121
- Think about whether your change actually needs documenting in upgrade notes:
2222
- if your change is in a plugin then it probably does not have any public APIs
2323
- most bug fixes do not need to be noted unless they change an API
24-
- When deprecating a feature, the replacement should also be mentioned
24+
- When deprecating a feature, the replacement should also be mentioned. To put it another way: what developers want to know is the right way to do things in the future, so focus on explaining that.
2525

2626
## Using `upgradenotes`
2727

0 commit comments

Comments
 (0)