open-telemetry / open-telemetry/opentelemetry-cpp

::variant documentation is not clear enough

Open
#2,539 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug help wanted Stale triage/accepted
Dominant language
C++
Stars
1.4k
Forks
632
Avg merge
1d 13h
Merged PRs (30d)
75

Description

Uses Abseil C++ Library for absl::variant as default nostd::variant if WITH_ABSEIL cmake option or --@io_opentelemetry_cpp//api:with_abseil=true (aka --//api:with_abseil=true) bazel option is enabled. License: Apache License 2.0

https://github.com/open-telemetry/opentelemetry-cpp/blob/main/docs/dependencies.md

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 with docs/dependencies.md, the file linked in the issue, and compare its current explanation of nostd::variant with the issue's CMake and Bazel options. Done means the documentation clearly explains when absl::variant is used as the default and identifies the relevant configuration options.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.