diff --git a/conan/api/conan_api.py b/conan/api/conan_api.py index 7b6fd14fec1..30fe82cc217 100644 --- a/conan/api/conan_api.py +++ b/conan/api/conan_api.py @@ -25,6 +25,11 @@ class ConanAPI: + """ + This is the main object to interact with the Conan API. It provides all the subapis to work with + recipes, packages, remotes, etc., which are exposed as attributes of this class, and should + not be created directly. + """ def __init__(self, cache_folder=None): version = sys.version_info @@ -61,6 +66,9 @@ def __init__(self, cache_folder=None): _check_conan_version(self) def reinit(self): + """ + Reinitialize the Conan API. This is useful when the configuration changes. + """ self.config.reinit() self.remotes.reinit() self.local.reinit()