From 83d9e79bd2a800d34d6c4c169f72c524bfc6281b Mon Sep 17 00:00:00 2001 From: Brad Jorsch Date: Mon, 21 Dec 2015 10:27:46 -0500 Subject: [PATCH] API: Improve description for ApiQueryPrefixSearch 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 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/api/i18n/en.json b/includes/api/i18n/en.json index 263f1375ab..ea854116fe 100644 --- a/includes/api/i18n/en.json +++ b/includes/api/i18n/en.json @@ -916,7 +916,7 @@ "apihelp-query+pageswithprop-example-simple": "List the first 10 pages using {{DISPLAYTITLE:}}.", "apihelp-query+pageswithprop-example-generator": "Get additional information about the first 10 pages using __NOTOC__.", - "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 [[Special:ApiHelp/query+allpages|action=query&list=allpages]] with the apprefix parameter. The purpose of this module is similar to [[Special:ApiHelp/opensearch|action=opensearch]]: 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.", -- 2.20.1