conan-io / conan-io/docs

Better documentation for transitive header and transitive libs (traits)

Open
#3,456 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
C++
Stars
125
Forks
382
Avg merge
22h 39m
Merged PRs (30d)
21

Description

When looking for `transitive_headers` and `transitive_libs` parameter for [requirements](https://docs.conan.io/2/reference/conanfile/methods/requirements.html#requirements), I can find:

- https://docs.conan.io/2/reference/conanfile/methods/requirements.html#transitive-headers
- https://docs.conan.io/2/reference/conanfile/methods/requirements.html#transitive-libs

Still, the documentation only specifies the WHAT, not the WHY, or recommended cases.

Right now, the [requirements traits](https://github.com/conan-io/tribe/blob/main/design/026-requirements_traits.md) design is more informative, and could be used as inspiration.

It would be great if we have a better explanation, like:

- Transitive headers are useful when a public header of a project has included a downstream header, resulting that the consumer will need to have access to both upstream and downstream headers

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.