conan-io / conan-io/docs

No generators explanation for conan.tools.cmake.CMakeToolchain initialiser

Open
#2,298 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

The docs here

https://github.com/conan-io/docs/blob/develop/reference/conanfile/tools/cmake/cmaketoolchain.rst#constructor

says

constructor
def __init__(self, conanfile, generator=None):
conanfile: the current recipe object. Always use self.
namespace: this argument avoids collisions when you have multiple toolchain calls in the same recipe. By setting this argument, the conanbuild.conf file used to pass information to the build helper will be named as: _conanbuild.conf. The default value is None meaning that the name of the generated file is conanbuild.conf. This namespace must be also set with the same value in the constructor of the CMake build helper so that it reads the information from the proper file.

but the 2nd arg is generator, not namespace,

Contributor guide

No contributing guide indexed for this repository

Research direction

Open reference/conanfile/tools/cmake/cmaketoolchain.rst and inspect the constructor section linked in the issue. Correct the second argument documentation so it describes generator rather than namespace, then review the rendered wording to confirm it matches the shown __init__ signature.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.