conan-io / conan-io/docs

Document exemplar usage of the Conan API

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

Description

It's really good to have a reference for the conan API and what's currently there is useful in pointing in the right direction, I think it would be really valuable to have code snippets that exemplified the usage of each of the API interfaces. It's useful to know where things should be imported from, how to construct the data required as arguments, the types that the interface has and where this can be obtained from. Examples will help to solidify an understanding of how to use it.

As it stands, I'm inspecting the `conan` codebase to confirm my suspicions about usage requirements, which isn't great from a UX perspective at the moment.

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.