From 4594561580cfb655eebd6ad1f6dde5e1def4d1ae Mon Sep 17 00:00:00 2001 From: Christian Oliff Date: Thu, 23 May 2024 18:08:27 +0900 Subject: [PATCH] Docs: typo fixes (#4152) various typo fixes to docs --- CHANGELOG.md | 24 ++++++++++++------------ CONTRIBUTING.md | 2 +- build/readme.md | 2 ++ developer-guides/life-of-a-tile.md | 2 +- docs/README.md | 2 +- docs/guides/mapbox-migration-guide.md | 2 +- docs/plugins.md | 2 +- docs/style-spec.md | 2 +- test/README.md | 2 +- test/integration/README.md | 6 +++--- 10 files changed, 24 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 383d8ab6d2..d5af7e5701 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -140,7 +140,7 @@ - ⚠️ Moved the `addSourceType` to be a part of the global maplibregl object instead of being per map object ([#3420](https://github.com/maplibre/maplibre-gl-js/pull/3420)) - ⚠️ Removed callback usage from `map.loadImage` in continue to below change ([#3422](https://github.com/maplibre/maplibre-gl-js/pull/3422)) - ⚠️ Changed the `GeoJSONSource`'s `getClusterExpansionZoom`, `getClusterChildren`, `getClusterLeaves` methods to return a `Promise` instead of a callback usage ([#3421](https://github.com/maplibre/maplibre-gl-js/pull/3421)) -- ⚠️ Changed the `setRTLTextPlugin` function to return a promise instead of using callback ([#3418](https://github.com/maplibre/maplibre-gl-js/pull/3418)) this also changed how the RTL pluing code is handled internally by splitting the main thread and worker thread code. +- ⚠️ Changed the `setRTLTextPlugin` function to return a promise instead of using callback ([#3418](https://github.com/maplibre/maplibre-gl-js/pull/3418)) this also changed how the RTL plugin code is handled internally by splitting the main thread and worker thread code. - ⚠️ Remove `setCooperativeGestures` and `getCooperativeGestures` functions in favor of `cooperativeGestures` handler which now has an `enabled()` or `disabled()` methods ([#3430](https://github.com/maplibre/maplibre-gl-js/pull/3430)) - ⚠️ Changed the undeling worker communication from callbacks to promises. This has a breaking effect on the implementation of custom `WorkerSource` and how it behaves ([#3233](https://github.com/maplibre/maplibre-gl-js/pull/3233)) - ⚠️ Changed the `Source` interface to return promises instead of callbacks ([#3233](https://github.com/maplibre/maplibre-gl-js/pull/3233)) @@ -151,12 +151,12 @@ - Changed `ImageRequest` to be `Promise` based ([#3233](https://github.com/maplibre/maplibre-gl-js/pull/3233)) - Improved precision and added a subtle fade transition to marker opacity changes ([#3431](https://github.com/maplibre/maplibre-gl-js/pull/3431)) - Adds support for terrain in `setStyle` with diff method ([#3515](https://github.com/maplibre/maplibre-gl-js/pull/3515), [#3463](https://github.com/maplibre/maplibre-gl-js/pull/3463)) -- Upgraded to use Node JS 20 and removed the dependency of `gl` package from the tests to allow easier develpment setup. ([#3452](https://github.com/maplibre/maplibre-gl-js/pull/3452)) +- Upgraded to use Node JS 20 and removed the dependency of `gl` package from the tests to allow easier development setup. ([#3452](https://github.com/maplibre/maplibre-gl-js/pull/3452)) ### 🐞 Bug fixes - Fix wheel zoom to be into the same direction above or under the horizon ([#3398](https://github.com/maplibre/maplibre-gl-js/issues/3398)) -- Fix \_cameraForBoxAndBearing not fitting bounds properly when using asymettrical camera viewport and bearing.([#3591](https://github.com/maplibre/maplibre-gl-js/pull/3591)) +- Fix \_cameraForBoxAndBearing not fitting bounds properly when using asymmetrical camera viewport and bearing.([#3591](https://github.com/maplibre/maplibre-gl-js/pull/3591)) - Fix missing export `Map` type in the `d.ts` file ([#3564](https://github.com/maplibre/maplibre-gl-js/pull/3564)) - Fix the shifted mouse events after a css transform scale on the map container ([#3437](https://github.com/maplibre/maplibre-gl-js/pull/3437)) - Fix markers remaining transparent when disabling terrain ([#3431](https://github.com/maplibre/maplibre-gl-js/pull/3431)) @@ -191,7 +191,7 @@ ### 🐞 Bug fixes - Fix wheel zoom to be into the same direction above or under the horizon ([#3398](https://github.com/maplibre/maplibre-gl-js/issues/3398)) -- Fix \_cameraForBoxAndBearing not fitting bounds properly when using asymettrical camera viewport and bearing ([#3591](https://github.com/maplibre/maplibre-gl-js/pull/3591)) +- Fix \_cameraForBoxAndBearing not fitting bounds properly when using asymmetrical camera viewport and bearing ([#3591](https://github.com/maplibre/maplibre-gl-js/pull/3591)) ## 4.0.0-pre.4 @@ -204,7 +204,7 @@ ### ✨ Features and improvements - ⚠️ Add the ability to import a script in the worker thread and call `addProtocol` and `removeProtocol` there ([#3459](https://github.com/maplibre/maplibre-gl-js/pull/3459)) - this also changed how `addSourceType` works since now you'll need to load the script with `maplibregl.importScriptInWorkers`. -- Upgraded to use Node JS 20 and removed the dependency of `gl` package from the tests to allow easier develpment setup. ([#3452](https://github.com/maplibre/maplibre-gl-js/pull/3452)) +- Upgraded to use Node JS 20 and removed the dependency of `gl` package from the tests to allow easier development setup. ([#3452](https://github.com/maplibre/maplibre-gl-js/pull/3452)) - Improved precision and added a subtle fade transition to marker opacity changes ([#3431](https://github.com/maplibre/maplibre-gl-js/pull/3431)) - Adds support for terrain in `setStyle` with diff method ([#3515](https://github.com/maplibre/maplibre-gl-js/pull/3515), [#3463](https://github.com/maplibre/maplibre-gl-js/pull/3463)) @@ -222,7 +222,7 @@ - ⚠️ Moved the `addSourceType` to be a part of the global maplibregl object instead of being per map object ([#3420](https://github.com/maplibre/maplibre-gl-js/pull/3420)) - ⚠️ Removed callback usage from `map.loadImage` in continue to below change ([#3422](https://github.com/maplibre/maplibre-gl-js/pull/3422)) - ⚠️ Changed the `GeoJSONSource`'s `getClusterExpansionZoom`, `getClusterChildren`, `getClusterLeaves` methods to return a `Promise` instead of a callback usage ([#3421](https://github.com/maplibre/maplibre-gl-js/pull/3421)) -- ⚠️ Changed the `setRTLTextPlugin` function to return a promise instead of using callback ([#3418](https://github.com/maplibre/maplibre-gl-js/pull/3418)) this also changed how the RTL pluing code is handled internally by splitting the main thread and worker thread code. +- ⚠️ Changed the `setRTLTextPlugin` function to return a promise instead of using callback ([#3418](https://github.com/maplibre/maplibre-gl-js/pull/3418)) this also changed how the RTL plugin code is handled internally by splitting the main thread and worker thread code. - ⚠️ Remove `setCooperativeGestures` and `getCooperativeGestures` functions in favor of `cooperativeGestures` handler which now has an `enabled()` or `disabled()` methods ([#3430](https://github.com/maplibre/maplibre-gl-js/pull/3430)) - Created a new example showing how to place a threejs scene as a `CustomLayer` over maplibre 3d-terrain ([#3429](https://github.com/maplibre/maplibre-gl-js/pull/3429)) @@ -382,7 +382,7 @@ - Immediately redraw the map after setting pixel ratio ([#2674](https://github.com/maplibre/maplibre-gl-js/pull/2673)) - Add maxCanvasSize option to limit canvas size. It can prevent reaching the GL limits and reduce the load on the devices. Default value is [4096, 4096]. - Reduce maxCanvasSize when hitting GL limits to avoid distortions ([#2674](https://github.com/maplibre/maplibre-gl-js/pull/2673)) -- Rewrite all the code comments in TSDocs, introduced a new documentaiton system and moved examples into this repository for better debug options ([#2756](https://github.com/maplibre/maplibre-gl-js/pull/2756)) +- Rewrite all the code comments in TSDocs, introduced a new documentation system and moved examples into this repository for better debug options ([#2756](https://github.com/maplibre/maplibre-gl-js/pull/2756)) - ⚠️ Removed non documented `Marker` constructor parameter ([#2756](https://github.com/maplibre/maplibre-gl-js/pull/2756)) - Updated `check-for-support` example ([#2859](https://github.com/maplibre/maplibre-gl-js/pull/2859)) @@ -402,7 +402,7 @@ ### 🐞 Bug fixes -- Fix regression - Add webgl1 fallback to accomondate users without webgl2 support ([#2653](https://github.com/maplibre/maplibre-gl-js/issues/2653)) +- Fix regression - Add webgl1 fallback to accommodate users without webgl2 support ([#2653](https://github.com/maplibre/maplibre-gl-js/issues/2653)) ## 3.0.1 @@ -730,7 +730,7 @@ Everything from the four previous pre-releases: - Handle maxBounds which cross the meridian at longitude ±180° ([#1298](https://github.com/maplibre/maplibre-gl-js/pull/1298), [#1299](https://github.com/maplibre/maplibre-gl-js/pull/1299)) - Hide arrow displayed in default `summary` styles on the attribution control ([#1258](https://github.com/maplibre/maplibre-gl-js/pull/1258)) - Fix memory usage in terrain 3D ([#1291](https://github.com/maplibre/maplibre-gl-js/issues/1291), [#1302](https://github.com/maplibre/maplibre-gl-js/pull/1302)) -- Fix disappearence of closest tiles when 3D terrain is enabled ([#1241](https://github.com/maplibre/maplibre-gl-js/issues/1241), [#1300](https://github.com/maplibre/maplibre-gl-js/pull/1300)) +- Fix disappearance of closest tiles when 3D terrain is enabled ([#1241](https://github.com/maplibre/maplibre-gl-js/issues/1241), [#1300](https://github.com/maplibre/maplibre-gl-js/pull/1300)) ## 2.2.0-pre.4 @@ -751,7 +751,7 @@ Everything from the four previous pre-releases: - Handle maxBounds which cross the meridian at longitude ±180° ([#1298](https://github.com/maplibre/maplibre-gl-js/issues/1298), [#1299](https://github.com/maplibre/maplibre-gl-js/pull/1299)) - Hide arrow displayed in default `summary` styles on the attribution control ([#1258](https://github.com/maplibre/maplibre-gl-js/pull/1258)) - Fix memory usage in terrain 3D ([#1291](https://github.com/maplibre/maplibre-gl-js/issues/1291), [#1302](https://github.com/maplibre/maplibre-gl-js/pull/1302)) -- Fix disappearence of closest tiles when 3D terrain is enabled ([#1241](https://github.com/maplibre/maplibre-gl-js/issues/1241), [#1300](https://github.com/maplibre/maplibre-gl-js/pull/1300)) +- Fix disappearance of closest tiles when 3D terrain is enabled ([#1241](https://github.com/maplibre/maplibre-gl-js/issues/1241), [#1300](https://github.com/maplibre/maplibre-gl-js/pull/1300)) ## 2.2.0-pre.2 @@ -864,7 +864,7 @@ Everything from the four previous pre-releases: ### Features and improvements -- Default compact attribution to be open by default to comply with OpenSteetMap Attribution Guidelines ([#795](https://github.com/maplibre/maplibre-gl-js/pull/795)) +- Default compact attribution to be open by default to comply with OpenStreetMap Attribution Guidelines ([#795](https://github.com/maplibre/maplibre-gl-js/pull/795)) - Export `Source` classes (`GeoJSONSource` etc.) declarations. ([#801](https://github.com/maplibre/maplibre-gl-js/issues/801)) - Make `AJAXError` public so error HTTP responses can be handled differently from other errors. @@ -1284,7 +1284,7 @@ This patch introduces two workarounds that address longstanding issues related t ### 🍏 Improvements - Implement workaround for memory leak in Safari when using the `CacheStorage` API. ([#8856](https://github.com/mapbox/mapbox-gl-js/pull/8956)) -- Implement workaround for memory leak in Safari when using `Transferable` objects to transfer `ArrayBuffers` to WebWorkers. If GL-JS detetcts that it is running in Safari, the use of `Transferables` to transfer data to WebWorkers is disabled. ([#9003](https://github.com/mapbox/mapbox-gl-js/pull/9003)) +- Implement workaround for memory leak in Safari when using `Transferable` objects to transfer `ArrayBuffers` to WebWorkers. If GL-JS detects that it is running in Safari, the use of `Transferables` to transfer data to WebWorkers is disabled. ([#9003](https://github.com/mapbox/mapbox-gl-js/pull/9003)) - Improve animation performance when using `map.setData`. ([#8913](https://github.com/mapbox/mapbox-gl-js/pull/8913)) (h/t [msbarry](https://github.com/msbarry)) ## 1.5.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da42b7dc45..95a45179e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,7 @@ This is not intended to be a strict process but rather a guideline that will bui ### CodeSpaces -By creating a code spcace you should be able to start working immidiately after the post create script finishes running. +By creating a code space you should be able to start working immediately after the post create script finishes running. This script basically installes everything written here in the linux part. ### OSX diff --git a/build/readme.md b/build/readme.md index 7cdc9a9432..a7aabc84b0 100644 --- a/build/readme.md +++ b/build/readme.md @@ -1,6 +1,8 @@ # Build Scripts + This folder holds common build scripts accessed via the various `npm run` commands. Codegen is executed when calling `npm install` in order to generate all artifacts needed for the build to pass + ## Bundeling all the code The bundling process can be split into several steps: diff --git a/developer-guides/life-of-a-tile.md b/developer-guides/life-of-a-tile.md index 8e980c4d04..b5e54be780 100644 --- a/developer-guides/life-of-a-tile.md +++ b/developer-guides/life-of-a-tile.md @@ -106,7 +106,7 @@ sequenceDiagram source->>source: loadVectorData()
decode response end source-->>source_cache: Tile - source_cache-->>source_cache: _backfillDEM()
copy 1px buffer
from neigboring tiles + source_cache-->>source_cache: _backfillDEM()
copy 1px buffer
from neighboring tiles source->>source: fire('data', {
dataType: 'source'
}) source->>source_cache:
source_cache->map:
diff --git a/docs/README.md b/docs/README.md index 391fb6bd34..4cf83f8e69 100644 --- a/docs/README.md +++ b/docs/README.md @@ -61,7 +61,7 @@ When you create a new example, you **must** make an accompanying image. 1. Run `npm run generate-images `. The script will take a screenshot of the map in the example and save it to `docs/assets/examples/`. 2. Commit the image. -For some examples, `npm run generate-images` does not generate an ideal image. In these cases, you can interact with the map after running the command before the screenshot is taken, or take a screenshot yourself by running the site locally with `npm start`, take a screenshot and save it in the `docs/assests/examples/` folder. +For some examples, `npm run generate-images` does not generate an ideal image. In these cases, you can interact with the map after running the command before the screenshot is taken, or take a screenshot yourself by running the site locally with `npm start`, take a screenshot and save it in the `docs/assets/examples/` folder. To regenerate all images, run `npm run generate-images`. Note that this doesn't support interaction and examples that require manual interaction (e.g. popups) will need to be manually redone afterward. This feature is experimental and may crash before successfully generating all examples. diff --git a/docs/guides/mapbox-migration-guide.md b/docs/guides/mapbox-migration-guide.md index 3321d371e8..7813cc725b 100644 --- a/docs/guides/mapbox-migration-guide.md +++ b/docs/guides/mapbox-migration-guide.md @@ -2,7 +2,7 @@ This part of the docs is dedicated to the migration from `mapbox-gl` to `maplibre-gl`. -This guide might not be accurate depending on the current version of `mapbox-gl` but should be failry straight forward. +This guide might not be accurate depending on the current version of `mapbox-gl` but should be fairly straight forward. The libraries are very similar but diverge with newer features happening from v2 in both libraries where Mapbox turned proprietary. diff --git a/docs/plugins.md b/docs/plugins.md index 37e0420465..30ec1da0e9 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -92,7 +92,7 @@ Draw routes and areas snapped to roads.
[View on GitHub](https://github.com/dabreegster/route_snapper) #### svelte-maplibre-components -A set of maplibre plugins to integrate with svelte/sveltekit. The respository consists of various useful plugins such as export plugin, legend plugin, measure plugin, attribute table plugin, tour plugin, etc. +A set of maplibre plugins to integrate with svelte/sveltekit. The repository consists of various useful plugins such as export plugin, legend plugin, measure plugin, attribute table plugin, tour plugin, etc.
[View on GitHub](https://github.com/watergis/svelte-maplibre-components) ## Map Rendering Plugins diff --git a/docs/style-spec.md b/docs/style-spec.md index ea83b740a4..53f438814c 100644 --- a/docs/style-spec.md +++ b/docs/style-spec.md @@ -2,7 +2,7 @@ The style spec is the definition language for the visualization of the map. It can be fine tuned to show the most amazing maps! -In order to learn it better the following documenation site was created for it: +In order to learn it better the following documentation site was created for it: [Style Specifications](https://maplibre.org/maplibre-style-spec/) diff --git a/test/README.md b/test/README.md index 549be01e31..ac43acef93 100644 --- a/test/README.md +++ b/test/README.md @@ -21,7 +21,7 @@ To run specific tests: - Unit test by file name : `npx jest path/to/file.test.ts --reporters=default` (e.g. `npx jest src/style/style_layer.test.ts`) - Unit test that matches a test name: `npx jest path/to/file.test.ts --reporters=default -t "test name"` - - Browser test that matches a test name: `npx jest test/integration/browser/browser.test.ts --reporters=default -t "test name"`, in some cases here you might want to change the headeless mode in the test file to be `false` to see what's happening in the browser. + - Browser test that matches a test name: `npx jest test/integration/browser/browser.test.ts --reporters=default -t "test name"`, in some cases here you might want to change the headless mode in the test file to be `false` to see what's happening in the browser. - Render tests that matches a folder or file names: `npm run test-render -- render-test-name` (e.g. `npm run test-render -- text-rotation-alignment`) To run folders in watch mode, meaning they will run continuously as you make changes to relevant code, (i.e. for test driven development): use `npm run test-watch-roots *folder1* [*folder2*...]` (e.g. `npm run test-watch-roots ./src/ui/control`) diff --git a/test/integration/README.md b/test/integration/README.md index c21e1ad97c..14e8ca7464 100644 --- a/test/integration/README.md +++ b/test/integration/README.md @@ -18,11 +18,11 @@ The contents of vector tile fixtures can be read using the [`vt2geojson`](https: ## Running tests in GitHub All tests are run for every PR. If you're not sure yet if the tests are good, you may use a Draft PR to indicate that the work is still in progress. -Each jos, or a group of tests, will create an atrifact of any of its tests fail. The artifacts are found at the bottom of the jobs summary +Each jos, or a group of tests, will create an artifact of any of its tests fail. The artifacts are found at the bottom of the jobs summary -Download the appropriate artifact as a zip file, open it and view the `resutls.html` file it contains. +Download the appropriate artifact as a zip file, open it and view the `results.html` file it contains. The "Actual" image of a failed test can be saved and used as the new "Expected" image. ## Running tests in the development environment @@ -137,7 +137,7 @@ In test/integration/lib/query-browser-jest.test.ts a web server is automatically npx st -l --port 7357 -d test/integration -co ``` -We currently run each test in a new tab. Alterantively we might gain some speed by clearing the webgl context instead, and running everything in one tab. +We currently run each test in a new tab. Alternatively we might gain some speed by clearing the webgl context instead, and running everything in one tab. ``` delete map.painter.context.gl;