Skip to content

Commit a1de17e

Browse files
timhuntandrewnicols
authored andcommitted
Update upgradenotes.md
Small, but hopefully useful, wording addition.
1 parent c2cbd67 commit a1de17e

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

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)