Skip to content

Commit 9d62f15

Browse files
committed
[docs] Further clarify final deprecation procedure
Signed-off-by: Daniel Ziegenberg <daniel@ziegenberg.at>
1 parent 56d3654 commit 9d62f15

File tree

1 file changed

+2
-1
lines changed
  • general/development/policies/deprecation

1 file changed

+2
-1
lines changed

general/development/policies/deprecation/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The final deprecation policy for Moodle LMS has been updated to align more close
136136

137137
#### Procedure
138138

139-
- When a function undergoes final deprecation, all content of the function should be removed. In the skeleton that remains, an error statement should be included that indicates that the function cannot be used anymore. You should also direct developers to the new function(s) in this message.
139+
- When a function undergoes final deprecation, all content of the function should be removed. In the skeleton that remains, an error statement should be included that indicates that the function cannot be used anymore. You should also direct developers to the new function(s) in this message, if the deprecated function has been replaced with a new function.
140140

141141
<Tabs>
142142

@@ -175,6 +175,7 @@ throw new coding_exception(
175175
- Function signatures _may_ be removed, that is:
176176
- all parameters may be removed; and
177177
- and return type declaration may be removed.
178+
- If the method or function has a typed return, it needs to return accordingly, otherwise no return is required.
178179
- The deprecation 'since' tag should remain as the version where the _initial_ deprecation happened.
179180
- Deprecated classes must be completely removed.
180181
- The content of the PHPDoc should be removed, leaving only the `@deprecated` tag with the notice and, optionally, the replacement information. This includes all `@param`, `@return`, and other tags, as well as the description.

0 commit comments

Comments
 (0)