API: Improve description for ApiQueryPrefixSearch
authorBrad Jorsch <bjorsch@wikimedia.org>
Mon, 21 Dec 2015 15:27:46 +0000 (10:27 -0500)
committerBrad Jorsch <bjorsch@wikimedia.org>
Mon, 21 Dec 2015 15:29:21 +0000 (10:29 -0500)
Make it clear that the purpose of ApiQueryPrefixSearch is ''search'',
not to be an equivalent of Special:PrefixIndex.

Change-Id: I5012d8e99b3250723d875fbb9ed5fbc08e53ca17

includes/api/i18n/en.json

index 263f137..ea85411 100644 (file)
        "apihelp-query+pageswithprop-example-simple": "List the first 10 pages using <code>&#123;&#123;DISPLAYTITLE:&#125;&#125;</code>.",
        "apihelp-query+pageswithprop-example-generator": "Get additional information about the first 10 pages using <code>_&#95;NOTOC_&#95;</code>.",
 
-       "apihelp-query+prefixsearch-description": "Perform a prefix search for page titles.",
+       "apihelp-query+prefixsearch-description": "Perform a prefix search for page titles.\n\nDespite the similarity in names, this module is not intended to be equivalent to [[Special:PrefixIndex]]; for that, see <kbd>[[Special:ApiHelp/query+allpages|action=query&list=allpages]]</kbd> with the <kbd>apprefix</kbd> parameter. The purpose of this module is similar to <kbd>[[Special:ApiHelp/opensearch|action=opensearch]]</kbd>: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.",
        "apihelp-query+prefixsearch-param-search": "Search string.",
        "apihelp-query+prefixsearch-param-namespace": "Namespaces to search.",
        "apihelp-query+prefixsearch-param-limit": "Maximum number of results to return.",