Repository navigation
[docs] Improve docs relating to documentation of overridden methods - #1747
Merged
Merged
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain, and the documentation-only changes are scoped to clarifying guidance for documenting overridden methods.
No open issues 🎉
What changed in this PR
This pull request clarifies Moodle coding-style guidance for documenting methods that override parent classes, interfaces, or traits.
Changes:
- Removes the previous tip admonition around overriding methods.
- Clarifies the PHPCS behavior associated with
#[\Override]. - Emphasizes retaining useful, more-specific documentation on overriding methods.
- Adds guidance against removing child documentation unnecessarily.
| File | Description |
|---|---|
general/development/policies/codingstyle/index.md |
Refines documentation guidance and admonition text for overridden methods. |
Review effort: Lite
andrewnicols
force-pushed
the
improveOverrideDocs
branch
from
November 5, 2026 15:02
998e54e to
2ba527b
Compare
paulholden
approved these changes
Nov 5, 2026
paulholden
left a comment
paulholden
left a comment
Member
There was a problem hiding this comment.
I wholeheartedly approve of this, thank you Andrew!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.