Update limit/urlwidth param doc of prop=imageinfo
authorumherirrender <umherirrender_de.wp@web.de>
Thu, 4 Apr 2013 15:34:22 +0000 (17:34 +0200)
committerGerrit Code Review <gerrit@wikimedia.org>
Thu, 11 Apr 2013 17:13:01 +0000 (17:13 +0000)
Follow up Id0ec6a and to clarify things like bug 46782

Change-Id: I2215d022a47cd8ceeadd2f5d38064495f3197772

includes/api/ApiQueryImageInfo.php

index 87bdbfe..0869cb9 100644 (file)
@@ -569,11 +569,12 @@ class ApiQueryImageInfo extends ApiQueryBase {
                return array(
                        'prop' => self::getPropertyDescriptions( array(), $p ),
                        'urlwidth' => array( "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
-                                               'Only the current version of the image can be scaled' ),
+                               'For performance reasons if this option is used, ' .
+                                       'no more than ' . self::TRANSFORM_LIMIT . ' scaled images will be returned.' ),
                        'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth",
                        'urlparam' => array( "A handler specific parameter string. For example, pdf's ",
                                "might use 'page15-100px'. {$p}urlwidth must be used and be consistent with {$p}urlparam" ),
-                       'limit' => 'How many image revisions to return',
+                       'limit' => 'How many image revisions to return per image',
                        'start' => 'Timestamp to start listing from',
                        'end' => 'Timestamp to stop listing at',
                        'metadataversion' => array( "Version of metadata to use. if 'latest' is specified, use latest version.",