Skip to content

Commit 7a2f506

Browse files
committed
[docs] Convert Deprecation into a new subsection
1 parent a5db243 commit 7a2f506

File tree

6 files changed

+11
-11
lines changed

6 files changed

+11
-11
lines changed

data/migratedPages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Debugging_network_requests_in_the_Moodle_App:
173173
- filePath: "/general/app/development/network-debug.md"
174174
slug: "/general/app/development/network-debug"
175175
Deprecation:
176-
- filePath: "/general/development/policies/deprecation.md"
176+
- filePath: "/general/development/policies/deprecation/index.md"
177177
slug: "/general/development/policies/deprecation"
178178
Designing_usable_forms:
179179
- filePath: "/general/development/policies/designing-usable-forms.md"

general/development/policies/codingstyle/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2028,7 +2028,7 @@ If you have a big task that is nearly done, apart a few TODOs, and you really wa
20282028

20292029
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).
20302030

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)
20322032

20332033
### CVS keywords
20342034

general/development/policies/deprecation.md renamed to general/development/policies/deprecation/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Both steps should always happen as earlier as possible in the 6-months period be
3838

3939
### Step 1. Immediate action
4040

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).
4242

4343
- 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.
4444
- 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
5454
```
5555

5656
- 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).
5858
- 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.
5959
- 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).
6060

@@ -229,8 +229,8 @@ Named parameter arguments are available from PHP 8.0 onwards.
229229

230230
## See also...
231231

232-
- [String deprecation](../../projects/api/string-deprecation.md)
232+
- [String deprecation](../../../projects/api/string-deprecation.md)
233233
- [External functions deprecation](/docs/apis/subsystems/external/writing-a-service#deprecation)
234234
- [Capabilities deprecation](/docs/apis/subsystems/access#deprecating-a-capability)
235-
- [Process](../process.md)
236-
- [Release process](../process/release/index.md)
235+
- [Process](../../process.md)
236+
- [Release process](../../process/release/index.md)

general/development/process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ Decisions will be posted on the issue and that issue will be closed, allowing an
319319

320320
- [Detailed workflow](./process/_files/workflow.jpg)
321321
- [Release process](./process/release)
322-
- [Deprecation](./policies/deprecation.md)
322+
- [Deprecation](./policies/deprecation/index.md)
323323
- [Integration dashboard](http://tracker.moodle.org/secure/Dashboard.jspa?selectPageId=11350)
324324
Walks-though of the process for contributors:
325325
- 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

general/development/process/peer-review/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ To allow the community of Moodle developers to work together, conventions should
4545
- Variables are named correctly (all lower case, no camel-case, no underscores).
4646
- Functions are named correctly (all lower case, no camel-case, underscores allowed).
4747
- 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.
4949
- The code doesn't use deprecated functions.
5050
- $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION are never used.
5151

@@ -182,7 +182,7 @@ Ensure that:
182182

183183
- The PHPdoc comments on all classes, methods and fields are useful. (Comments that just repeat the function name are not helpful! Add value.)
184184
- 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).
186186
- Appropriate [labels](../../tracker/labels.md) have been added when there has been a function change, particularly
187187
- docs_required (any functional change, usually paired with `ui_change`),
188188
- dev_docs_required (any change to APIs, usually paired with `api_change`),

general/development/process/release/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,4 +190,4 @@ Usually on Monday
190190

191191
## See also
192192

193-
- [Deprecation process](../../policies/deprecation.md)
193+
- [Deprecation process](../../policies/deprecation/index.md)

0 commit comments

Comments
 (0)