mapbox / mapbox/vector-tile-spec

Clarify 'extent` description

Open
#135 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
1k
Forks
213
PR merge metrics
No merged PRs in 30d

Description

Current comment (which doubles up as a developer documentation) on extent field is lacking clarity and description.
Consider current text evolution from v1.0.0 to v2.1

v1.0.0/1.0.1
// The bounding box in this tile spans from 0..4095 units
optional uint32 extent = 5 [ default = 4096 ];
v.2.0
// The bounding box in this tile spans from 0..4095 units
// Although this is an "optional" field it is required by the specification.
// See https://github.com/mapbox/vector-tile-spec/issues/47
optional uint32 extent = 5 [ default = 4096 ];
v2.1
// Although this is an "optional" field it is required by the specification.
// See https://github.com/mapbox/vector-tile-spec/issues/47
optional uint32 extent = 5 [ default = 4096 ];
Proposed clarification/add-on
// Positive number that denotes the size of a side of a square tile. 
// This in turn, defines unambiguously bounding box (extent) of a Vector Tile.
// Commonly used value is 4096, which is default but can be increased 
// to maintain higher coordinate precision. 
optional uint32 extent = 5 [ default = 4096 ];

Clarification of clarification :)
  • Positive number - number greater than zero.

  • It's optional by definition

  • ...size of side of a square.. - we consider all VTs to be regular quadrilateral which leads to =>

  • This in turn, defines unambiguously bounding box (extent) - explaining connection between size (what this really is) and extent ( used to unambiguously define).

  • and finally ..can be increased to maintain higher coordinate precision indicates usage e.g why it might have a different value in some context (via @springmeyer )

Maybe someone can help to make it more concise 🆘
/cc @springmeyer @kkaefer @flippmoke @ericfischer

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the v2.1 definition of the extent field and read its current comment alongside the v1.0.0, v1.0.1, and v2.0 wording shown here. Revise the developer documentation to clearly describe the positive square-tile side length, the default value of 4096, and its coordinate-precision use, then verify the resulting comment is concise and consistent with the specification.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.