Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Housekeeping: Improve docs and update outdated references to point to MapLibre #330

Merged
merged 43 commits into from
Nov 27, 2023

Conversation

m0nac0
Copy link
Collaborator

@m0nac0 m0nac0 commented Nov 14, 2023

This PR does quite some housekeeping in updating outdated references from mapbox to maplibre, mostly in doc comments in the web sub-package.

This obviously seems like a quite huge PR, but I think for the review it is sufficient to take a short look at the simple renamings (they are in separate commits and were done with IDE tooling) and maybe a cursory look at the doc comments.
The web documentation changes are quite unspectacular and probably barely anyone ever looks at the web-plugin docs, but I think we needed to do this housekeeping at some point.

  • updated documentation:

    • especially added new docs for the maplibre_gl library and MaplibreMapControler and MaplibreMap, as well as removing outdated comments in many places and adding some new ones to help new users better understand the plugin
    • the updates for the web documentation comments were also mostly done with a series of replace-all, sometimes manually updated to reflect the online API reference of MapLibre JS
  • the only "code changes" are a couple of (simple) renamings:

    • main plugin: renamed src/mapbox_map.dart to src/maplibre_map.dart
    • main plugin: renamed MapboxColorConversion to MapLibreColorConversion
    • main plugin: maplibreGlPlatform variable (the class was already renamed in the past) in controller.dart
    • main plugin: _MaplibreMapOptions class
    • web: "library maplibre" at the top of most files
    • web: MapboxMapJsImpl to MapLibreMapJsImpl
    • web: MapboxMapOptionsSink to MapLibreMapOptionsSink

All renamings were done only with the IDE renaming function. There are no functional changes and no changes in the public API, only some internal renamings and updated doc comments. (This can also be seen by the fact that the example app needs no updates, only two internal variables were renamed).

Nearly all remaining references to mapbox are in the android or ios directories.

@m0nac0 m0nac0 merged commit 6c88d54 into maplibre:main Nov 27, 2023
6 checks passed
@m0nac0 m0nac0 deleted the improve-docs branch November 27, 2023 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants