Improve normalizePageName documentation

[lhc/web/wiklou.git] / includes / site / MediaWikiPageNameNormalizer.php

diff --git a/includes/site/MediaWikiPageNameNormalizer.php b/includes/site/MediaWikiPageNameNormalizer.php
index 3e073f0..8a12c4f 100644 (file)
--- a/includes/site/MediaWikiPageNameNormalizer.php
+++ b/includes/site/MediaWikiPageNameNormalizer.php
@@ -54,6 +54,7 @@ class MediaWikiPageNameNormalizer {
         * Returns the normalized form of the given page title, using the
         * normalization rules of the given site. If the given title is a redirect,
         * the redirect will be resolved and the redirect target is returned.
+        * Only titles of existing pages will be returned.
         *
         * @note This actually makes an API request to the remote site, so beware
         *   that this function is slow and depends on an external service.
@@ -65,7 +66,9 @@ class MediaWikiPageNameNormalizer {
         * @param string $pageName
         * @param string $apiUrl
         *
-        * @return string|false
+        * @return string|false The normalized form of the title,
+        * or false to indicate an invalid title, a missing page,
+        * or some other kind of error.
         * @throws \MWException
         */
        public function normalizePageName( $pageName, $apiUrl ) {