You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: general/development/policies/codingstyle/index.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2028,7 +2028,7 @@ If you have a big task that is nearly done, apart a few TODOs, and you really wa
2028
2028
2029
2029
There is a nice "to-do checker" reporting tool, restricted to admins and available via web @ [`lib/tests/other/todochecker.php`](https://github.com/moodle/moodle/blob/master/lib/tests/other/todochecker.php).
2030
2030
2031
-
Finally, don't forget to add any MDL-12345 used by your TODOs (and @todos too, unless part of the [deprecation process](../deprecation.md), those are handled apart) to the "Review TODOs Epic": MDL-47779 (requires login to see the issues)
2031
+
Finally, don't forget to add any MDL-12345 used by your TODOs (and @todos too, unless part of the [deprecation process](../deprecation/index.md), those are handled apart) to the "Review TODOs Epic": MDL-47779 (requires login to see the issues)
Copy file name to clipboardExpand all lines: general/development/policies/deprecation/index.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Both steps should always happen as earlier as possible in the 6-months period be
38
38
39
39
### Step 1. Immediate action
40
40
41
-
Deprecation affects only the current master version, in other words, the deprecation only becomes effective after the next [major release](../../releases.md).
41
+
Deprecation affects only the current master version, in other words, the deprecation only becomes effective after the next [major release](../../../releases.md).
42
42
43
43
- If the function is not a member of a class (in other words, it is an independent function), it should be moved, with its PHPDoc and all comments, to `lib/deprecatedlib.php`, which is included everywhere. If the function is a class member, it will need to be deprecated in its current location.
44
44
- Deprecated behat step definitions should be moved to `lib/tests/behat/behat_deprecated.php`, including a call to `behat_deprecated::deprecated_message()` proposing an alternative to the deprecated method.
@@ -54,7 +54,7 @@ Deprecation affects only the current master version, in other words, the depreca
54
54
```
55
55
56
56
- If the deprecated function has been replaced with a new function, ideally the new function should be called from the deprecated function, so that the new functionality is used. This will make maintenance easier moving forward.
57
-
- A `@deprecated` tag should be added to the PHPDoc for the function description so that IDEs describing the function will note that it is deprecated, documenting which version it was deprecated in and the MDL issue associated with it. See the guidelines in [Coding style](./codingstyle/index.md#deprecated-and-todo).
57
+
- A `@deprecated` tag should be added to the PHPDoc for the function description so that IDEs describing the function will note that it is deprecated, documenting which version it was deprecated in and the MDL issue associated with it. See the guidelines in [Coding style](../codingstyle/index.md#deprecated-and-todo).
58
58
- If the function is an external function, then an additional deprecation-specific method needs to be created and set to return true. See the [adding a web service to a plugin](/docs/apis/subsystems/external/writing-a-service#deprecation) docs on that process. You should continue to add the `@deprecated since x.x` tag to the docs of all three of the relevant external methods (parameters, main method, returns) to make it clear to IDEs that the function is deprecated.
59
59
- There will need to be an issue associated with the initial part of the deprecation. A second issue needs to be created to finish the job. The first issue will be linked to second issue. The second issue needs to be a sub-task of an appropriate [deprecation META](https://tracker.moodle.org/issues/?jql=%28summary%20~%20%22meta%22%20or%20type%20%3D%20Epic%29%20AND%20summary%20~%20%22together%20deprecated%22%20order%20by%20created&runQuery=true&clear=true).
60
60
@@ -229,8 +229,8 @@ Named parameter arguments are available from PHP 8.0 onwards.
- By Dan Poltawski, Integrator: http://www.slideshare.net/poltawski/how-to-guarantee-your-change-is-integrated-to-moodle-core, https://www.youtube.com/watch?v=836WtnM2YpM
Copy file name to clipboardExpand all lines: general/development/process/peer-review/index.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ To allow the community of Moodle developers to work together, conventions should
45
45
- Variables are named correctly (all lower case, no camel-case, no underscores).
46
46
- Functions are named correctly (all lower case, no camel-case, underscores allowed).
47
47
- PHP DocBlocks have been updated and adhere to coding style guide.
48
-
- Where functions are being removed, the [deprecation policy](../../policies/deprecation.md) is followed.
48
+
- Where functions are being removed, the [deprecation policy](../../policies/deprecation/index.md) is followed.
49
49
- The code doesn't use deprecated functions.
50
50
- $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION are never used.
51
51
@@ -182,7 +182,7 @@ Ensure that:
182
182
183
183
- The PHPdoc comments on all classes, methods and fields are useful. (Comments that just repeat the function name are not helpful! Add value.)
184
184
- Where an API has been changed significantly, the relevant upgrade.txt file has been updated with information.
185
-
- Where something has been deprecated, that the comments don't just say "do NOT use this any more!!!" but actually follow the [deprecation policy](../../policies/deprecation.md).
185
+
- Where something has been deprecated, that the comments don't just say "do NOT use this any more!!!" but actually follow the [deprecation policy](../../policies/deprecation/index.md).
186
186
- Appropriate [labels](../../tracker/labels.md) have been added when there has been a function change, particularly
187
187
- docs_required (any functional change, usually paired with `ui_change`),
188
188
- dev_docs_required (any change to APIs, usually paired with `api_change`),
0 commit comments