Add glossary terms for apple-specific C++'isms

Open
#47 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate the project's glossary and review nearby entries for terminology and scope. Add a Frameworks entry explaining how Apple frameworks differ from the dynamic and static libraries preferred at Mapbox; done means the glossary clearly covers the distinction and the existing guidance remains consistent.

Written by the indexing model from the issue text.

Description

glossary

Apple systems support dynamic libraries organized as Frameworks. Because this way of organizing C/C++ code is not cross platform we generally don't recommend or use Frameworks at Mapbox. To clarify that apple systems support both dynamic and static libraries in the same way as other unix systems (and this is our preferred best practice) we should add Frameworks to the glossary to describe how they differ.

Dominant language
No language data
Stars
110
Forks
17
No merged PRs in 30d

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.

More from mapbox/cpp

All issues in mapbox/cpp

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.