docs: add more docstrings to mbtiles#1786
Merged
nyurik merged 5 commits intomaplibre:mainfrom Apr 12, 2025
Merged
Conversation
for more information, see https://pre-commit.ci
Contributor
There was a problem hiding this comment.
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
mbtiles/src/mbtiles.rs:136
- [nitpick] Consider using consistent naming for the
Mbtilesstruct in the documentation. ChangeMBTilestoMbtilesto match the struct name defined in the code.
/// See [`MBTiles::get_tile_and_hash`] if you need the hash too
CommanderStorm
commented
Apr 12, 2025
Member
Author
CommanderStorm
left a comment
CommanderStorm
left a comment
There was a problem hiding this comment.
xD
well, they don't exist (yet)
CommanderStorm
added a commit
that referenced
this pull request
Apr 15, 2025
(PR is based on #1786 => merge said PR first before looking at this one.) This PR adds support to the `mbtiles` crate to hand out which hash corresponds to a tile. The flat case might be debatable: Here I chose to md5 hash it to make upstream code more readable. The alternative would be to in this case return `None` for the hash. This looks more intimidating than it actully is. Most of the lines are unit-tests. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Yuri Astrakhan <yuriastrakhan@gmail.com>
Closed
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.
I did a bit of investigation what changes would be nessesary to support #580 and these are the changes where I worked myself through the functions in said crate.
Most are not related to the actual investigation, don't infer too much from which functions I looked at.