mapbox / mapbox/cpp

[glossary] add details about why forward declarations are useful

Open Beginner friendly
#53 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

glossary
Dominant language
No language data
Stars
110
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Generally forward declarations are useful when trying to avoid headers (and their deps) being public and/or to reduce compile times. This ticket is to track adding this note to the glossary.

/cc @GretaCB

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 locating the glossary and the existing entry for forward declarations. Add a concise note explaining their usefulness for avoiding public headers and dependencies and for reducing compile times, then verify that the glossary remains correctly formatted.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.