From 76b9907438bdc5fd57b37031c2387fef15053a59 Mon Sep 17 00:00:00 2001 From: Alex Wolf Date: Sun, 29 Sep 2024 13:56:42 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Improve=20documentation=20of=20S?= =?UTF-8?q?etupSettings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- lamindb_setup/core/_settings.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/lamindb_setup/core/_settings.py b/lamindb_setup/core/_settings.py index 0778964f6..1a15844b2 100644 --- a/lamindb_setup/core/_settings.py +++ b/lamindb_setup/core/_settings.py @@ -40,11 +40,18 @@ def settings_dir(self) -> Path: @property def auto_connect(self) -> bool: - """Auto-connect to loaded instance upon lamindb import. + """Auto-connect to current instance upon `import lamindb`. - `lamin init` and `lamin load` switch this to `True`. + Upon installing `lamindb`, this setting is `False`. + + Upon calling `lamin init` or `lamin connect` on the CLI, this setting is switched to `True`. `ln.connect()` doesn't change the value of this setting. + + You can manually change this setting + + - in Python: `ln.setup.settings.auto_connect = True/False` + - via the CLI: `lamin settings set auto-connect true/false` """ return self._auto_connect_path.exists()