mapbox / mapbox/simplestyle-spec

`marker-symbol` is too ambiguous and/or no longer supported

Open
#37 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
296
Forks
116
PR merge metrics
No merged PRs in 30d

Description

```
// OPTIONAL: default ""
// a symbol to position in the center of this icon
// if not provided or "", no symbol is overlaid
// and only the marker is shown
// Allowed values include
// - Icon ID
// - An integer 0 through 9
// - A lowercase character "a" through "z"
"marker-symbol": "bus",
```

- `bus` renders as an empty marker on GitHub preview, so it probably doesn't work anymore
- what is `symbol`? Is it JS Symbol? Is it google maps icon name? Is it from Leaflet? This is too ambiguous for a spec.
- what is `Icon ID`? Where can you get one? Is there a list? Can I add my own? Can I use iconfont id? How do I load an iconfont in a .geojson file? /s
- `An integer 0 through 9` and `A lowercase character "a" through "z"` probably means `You can render a character inside of marker if you provide an integer or a lowercase letter as value`?
- And there's no mention of the possibility to load icons from URL.

This spec property is horrible and should be properly redefined with a new release.

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

Start by reviewing the marker-symbol section quoted in the issue and compare its stated values with the behavior seen in GitHub preview. Define the ambiguous terms and the supported input sources, then update the specification and release documentation once the replacement behavior and compatibility expectations are agreed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.