Update help text for `pmtiles extract`
Open
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 56
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
Thank you for PMTiles — it's been so helpful to me!
While reading the docs for pmtiles extract, I noticed a few things that could be tweaked for clarity:
--bboxisn't listed under Options--regionsays "a GeoJSON Polygon, Multipolygon, Feature, or FeatureCollection", but I think it might help to add the purpose of the option and how it will be used (i.e. is it a spatial join between the features and tiles?)- It would be helpful to know what the default are for any options that have them.
I think these minor edits will help newcomers like myself get started with the CLI even faster 😄
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked CLI documentation section for pmtiles extract and review its Options list and descriptions. Add --bbox, explain the purpose and use of --region, and document defaults where applicable; done means the extract help text is clearer and complete for newcomers.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100