conan-io / docs

conan.io reStructuredText documentation
http://docs.conan.io
MIT License
104 stars 356 forks source link

Better documentation for transitive header and transitive libs (traits) #3456

Open uilianries opened 10 months ago

uilianries commented 10 months ago

When looking for transitive_headers and transitive_libs parameter for requirements, I can find:

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

Right now, the requirements traits design is more informative, and could be used as inspiration.

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

valgur commented 10 months ago

Yes, please. I wish the docs also mentioned how the default values for these two are determined - that they are mostly affected by the package_type attribute (and also maybe how) and the libs and headers parameters. The fact that transitive_libs is not needed for header-library but is for others can be a bit surprising at first.