Repository navigation
Fix outdated docs and shorten the README license section - #50
Merged
Merged
Conversation
- README: one short license paragraph instead of repeating Apache/MIT, setZoom() snippets now pass a Float, Example11 lists all map types - Example11 README was still written for the old NORMAL/TERRAIN/CYCLE constants, rewrite it for the 15 current map types, and point the app's API key hint to MAP_TYPES.md (API_KEYS.md does not exist) - PUBLIC_API, MAP_TYPES, LIFECYCLE: Float zoom, correct map type counts - PERFORMANCE: match the real decode options, drop made-up cache hit rates and benchmarking calls to internal APIs - Testing docs: no pinned versions (point to the version catalog), list all four instrumented test classes - Publishing and workflow docs: Central Portal tokens instead of the shut down OSSRH/JIRA, release checklist uses publish-release.sh
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Went through the docs and compared them with the code. A fair amount had drifted:
setZoom(14.0), which doesn't compile because the API takes a FloatMapType.NORMAL,TERRAINandCYCLE, which no longer exist, and talked about five map types and clearing the cache. It's rewritten for the 15 current types. The app itself pointed to adocs/API_KEYS.mdthat doesn't exist; it now points to MAP_TYPES.mdThe README license section said "Apache 2.0" six times in different ways, and repeated the MIT line again under Features. It's now one short paragraph.