diff options
| author | Thiemo Kreuz <thiemo.kreuz@wikimedia.de> | 2020-10-27 18:13:40 +0100 |
|---|---|---|
| committer | Thiemo Kreuz (WMDE) <thiemo.kreuz@wikimedia.de> | 2020-10-27 19:20:26 +0000 |
| commit | 1fc8d79ac61947b9529277b3e46d5b86e209a610 (patch) | |
| tree | 3512022a296088070b50f5e6a594d96dcdb11b5c /includes/api/ApiQueryRevisionsBase.php | |
| parent | f4a77a5760dbbb6ee14c461849548821addf98b7 (diff) | |
| download | mediawikicore-1fc8d79ac61947b9529277b3e46d5b86e209a610.tar.gz mediawikicore-1fc8d79ac61947b9529277b3e46d5b86e209a610.zip | |
Remove documentation that literally repeats the code
For example, documenting the method getUser() with "get the User
object" does not add any information that's not already there.
But I have to read the text first to understand that it doesn't
document anything that's not already obvious from the code.
Some of this is from a time when we had a PHPCS sniff that was
complaining when a line like `@param User $user` doesn't end
with some descriptive text. Some users started adding text like
`@param User $user The User` back then. Let's please remove
this.
Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
Diffstat (limited to 'includes/api/ApiQueryRevisionsBase.php')
| -rw-r--r-- | includes/api/ApiQueryRevisionsBase.php | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/includes/api/ApiQueryRevisionsBase.php b/includes/api/ApiQueryRevisionsBase.php index 24a29947c165..a7342b4acead 100644 --- a/includes/api/ApiQueryRevisionsBase.php +++ b/includes/api/ApiQueryRevisionsBase.php @@ -231,7 +231,7 @@ abstract class ApiQueryRevisionsBase extends ApiQueryGeneratorBase { * Extract information from the RevisionRecord * * @since 1.32, takes a RevisionRecord instead of a Revision - * @param RevisionRecord $revision Revision + * @param RevisionRecord $revision * @param object $row Should have a field 'ts_tags' if $this->fld_tags is set * @return array */ |