Skip to content

Commit

Permalink
Fix some inconsistencies and typos in docs and comments (maplibre#1773)
Browse files Browse the repository at this point in the history
  • Loading branch information
Caerbannog authored and acalcutt committed Dec 9, 2023
1 parent 927e501 commit 490bd95
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 18 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ If you want to contribute code:

4. Prefix your commit messages with the platform(s) your changes affect, e.g. `[ios]`.

Please note the special instructions for contributing new source code files, asset files, or user-facing strings to MapLibre Native for [iOS](platform/ios/CONTRIBUTING.md), [Android](platform/android/DEVELOPING.md) or [macOS](platform/ios/platform/macos/DEVELOPING.md).
Please note the special instructions for contributing new source code files, asset files, or user-facing strings to MapLibre Native for [iOS](platform/ios/CONTRIBUTING.md), [Android](platform/android/DEVELOPING.md) or [macOS](platform/macos/DEVELOPING.md).

## Design Proposals

Expand Down
2 changes: 1 addition & 1 deletion DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To check that the output of the rendering is correct, we compare actual rendered
The directory sturcture of the render tests looks like:

```
maetrics/
metrics/
integration/
render-tests/
<name-of-style-spec-feature>/
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ The documentation of MapLibre Native is a work in progress. To get an architectu

## Platforms

- [⭐️ Android](platform/android/README.md)
- [⭐️ iOS](platform/ios/platform/ios/README.md)
- [⭐️ Android](platform/android/README.md)
- [⭐️ iOS](platform/ios/README.md)
- [GLFW](platform/glfw)
- [Linux](platform/linux/README.md)
- [Node.js](platform/node/README.md)
- [Qt](platform/qt/README.md)
- [Windows](platform/windows/README.md)
- [macOS](platform/ios/platform/macos/README.md)
- [macOS](platform/macos/README.md)

Platforms with a ⭐️ are **MapLibre Core Projects** and have a substantial amount of financial resources allocated to them. Learn about the different [project tiers](https://github.com/maplibre/maplibre/blob/main/PROJECT_TIERS.md#project-tiers).

Expand All @@ -48,7 +48,7 @@ To contribute to MapLibre Native, see [`CONTRIBUTING.md`](CONTRIBUTING.md) and (

### Getting Involved

Join the `#maplibre-native` Slack channel at OSMUS. Get an invite at https://slack.openstreetmap.us/
Join the `#maplibre-native` Slack channel at OSMUS. Get an invite at https://slack.openstreetmap.us/

### Bounties 💰

Expand Down
2 changes: 1 addition & 1 deletion include/mbgl/renderer/renderer_frontend.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ class RendererObserver;
class UpdateParameters;

/// The RenderFrontend is the bridge between the Map and
/// platform used to update and observer the Renderer
/// platform used to update and observe the Renderer
///
/// It hides any threading specifics and always replies on
/// the original thread.
Expand Down
1 change: 1 addition & 0 deletions platform/android/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Clone the git repository and pull in submodules:

```bash
git clone [email protected]:maplibre/maplibre-native.git
cd maplibre-native
git submodule update --init --recursive
cd platform/android
```
Expand Down
10 changes: 0 additions & 10 deletions platform/node/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,6 @@ Finally, build:
cmake --build build -j $(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null)
```


If you are rebuilding after time has passed.

Then do:

```bash
make node
```

## Testing

To test the Node.js bindings:
Expand All @@ -81,7 +72,6 @@ To test the Node.js bindings:
npm test
```


## Merging your pull request

To clean up your pull request and prepare it for merging, update your local `main` branch, then run `git rebase -i main` from your pull request branch to squash/fixup commits as needed. When your work is ready to be merged, you can run `git merge --ff-only YOUR_BRANCH` from `main` or click the green merge button in the GitHub UI, which will automatically squash your branch down into a single commit before merging it.
Expand Down
1 change: 0 additions & 1 deletion platform/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Further platforms might work [with additional libraries installed](https://githu

```
npm test
npm run test-suite
```

## Rendering a map tile
Expand Down

0 comments on commit 490bd95

Please sign in to comment.