Skip to content

Commit 4632219

Browse files
committed
Changed the grammar from the form 'comprised of', to 'comprising' and updated the docs.
1 parent 2dfd4ed commit 4632219

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ A geocoder component using the [Mapbox Geocoding API][74]
110110
If reverseGeocode is enabled and no type is specified, the type defaults to POIs. Otherwise, if you configure more than one type, the first type will be used.
111111
* `options.minLength` **[Number][79]** Minimum number of characters to enter before results are shown. (optional, default `2`)
112112
* `options.limit` **[Number][79]** Maximum number of results to show. (optional, default `5`)
113-
* `options.language` **[string][76]?** Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas. Defaults to the browser's language settings.
113+
* `options.language` **[string][76]?** Specify the language to use for response text and query result weighting. Options are IETF language tags comprising mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas. Defaults to the browser's language settings.
114114
* `options.filter` **[Function][85]?** A function which accepts a Feature in the [extended GeoJSON][86] format to filter out results from the Geocoding API response before they are included in the suggestions list. Return `true` to keep the item, `false` otherwise.
115115
* `options.localGeocoder` **[Function][85]?** A function accepting the query string which performs local geocoding to supplement results from the Mapbox Geocoding API. Expected to return an Array of GeoJSON Features in the [extended GeoJSON][86] format.
116116
* `options.externalGeocoder` **[Function][85]?** A function accepting the query string and current features list which performs geocoding to supplement results from the Mapbox Geocoding API. Expected to return a Promise which resolves to an Array of GeoJSON Features in the [extended GeoJSON][86] format.
@@ -232,7 +232,7 @@ Look first at the explicitly set options otherwise use the browser's language se
232232

233233
#### Parameters
234234

235-
* `language` **[String][76]** Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
235+
* `language` **[String][76]** Specify the language to use for response text and query result weighting. Options are IETF language tags comprising mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
236236

237237
Returns **[MapboxGeocoder][2]** this
238238

lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ function getFooterNode() {
5757
* If reverseGeocode is enabled and no type is specified, the type defaults to POIs. Otherwise, if you configure more than one type, the first type will be used.
5858
* @param {Number} [options.minLength=2] Minimum number of characters to enter before results are shown.
5959
* @param {Number} [options.limit=5] Maximum number of results to show.
60-
* @param {string} [options.language] Specify the language to use for response text and query result weighting. Options are IETF language tags composed of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas. Defaults to the browser's language settings.
60+
* @param {string} [options.language] Specify the language to use for response text and query result weighting. Options are IETF language tags comprising mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas. Defaults to the browser's language settings.
6161
* @param {Function} [options.filter] A function which accepts a Feature in the [extended GeoJSON](https://docs.mapbox.com/api/search/geocoding-v5/#geocoding-response-object) format to filter out results from the Geocoding API response before they are included in the suggestions list. Return `true` to keep the item, `false` otherwise.
6262
* @param {Function} [options.localGeocoder] A function accepting the query string which performs local geocoding to supplement results from the Mapbox Geocoding API. Expected to return an Array of GeoJSON Features in the [extended GeoJSON](https://docs.mapbox.com/api/search/geocoding-v5/#geocoding-response-object) format.
6363
* @param {Function} [options.externalGeocoder] A function accepting the query string and current features list which performs geocoding to supplement results from the Mapbox Geocoding API. Expected to return a Promise which resolves to an Array of GeoJSON Features in the [extended GeoJSON](https://docs.mapbox.com/api/search/geocoding-v5/#geocoding-response-object) format.
@@ -1144,7 +1144,7 @@ MapboxGeocoder.prototype = {
11441144
* Get the language to use in UI elements and when making search requests
11451145
*
11461146
* Look first at the explicitly set options otherwise use the browser's language settings
1147-
* @param {String} language Specify the language to use for response text and query result weighting. Options are IETF language tags comprised of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
1147+
* @param {String} language Specify the language to use for response text and query result weighting. Options are IETF language tags comprising mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than one value can also be specified, separated by commas.
11481148
* @returns {MapboxGeocoder} this
11491149
*/
11501150
setLanguage: function(language){

0 commit comments

Comments
 (0)