From ee93c229fef4ed0b3cde55b6384bd8b704b7deac Mon Sep 17 00:00:00 2001 From: iLLiCiTiT Date: Thu, 8 Apr 2021 16:54:32 +0200 Subject: [PATCH] added some docstring to OpenPypeSecureRegistry --- igniter/user_settings.py | 11 +++++++++++ openpype/lib/local_settings.py | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/igniter/user_settings.py b/igniter/user_settings.py index bb5336a9ab..2a406f83dd 100644 --- a/igniter/user_settings.py +++ b/igniter/user_settings.py @@ -32,6 +32,17 @@ _PLACEHOLDER = object() class OpenPypeSecureRegistry: + """Store information using keyring. + + Registry should be used for private data that should be available only for + user. + + All passed registry names will have added prefix `OpenPype/` to easier + identify which data were created by OpenPype. + + Args: + name(str): Name of registry used as identifier for data. + """ def __init__(self, name): try: import keyring diff --git a/openpype/lib/local_settings.py b/openpype/lib/local_settings.py index ec76b57cfd..1bd8540acb 100644 --- a/openpype/lib/local_settings.py +++ b/openpype/lib/local_settings.py @@ -35,6 +35,17 @@ _PLACEHOLDER = object() class OpenPypeSecureRegistry: + """Store information using keyring. + + Registry should be used for private data that should be available only for + user. + + All passed registry names will have added prefix `OpenPype/` to easier + identify which data were created by OpenPype. + + Args: + name(str): Name of registry used as identifier for data. + """ def __init__(self, name): try: import keyring