Skip to content

[docs] Further clarify final deprecation procedure #1312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2025
Merged

[docs] Further clarify final deprecation procedure #1312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion general/development/policies/deprecation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,9 @@ public function foobar(int $old, array $params): array {

</Tabs>

- Keep the existing parameters and return type for both functions and methods.
- Function and Method signatures **must not change**, that is:
- keep any existing parameters; and
- keep any existing return type.
- The deprecation 'since' tag should remain as the version where the initial deprecation happened.
- Deprecated classes must be completely removed.
- 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.
Expand Down