From 130d5ad1c20119306fc3264065be07e633714163 Mon Sep 17 00:00:00 2001 From: Andrew Dunai Date: Tue, 13 Feb 2018 20:36:28 +0200 Subject: [PATCH] Docs. --- clay/settings.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/clay/settings.py b/clay/settings.py index 77a82d3..2498c7c 100644 --- a/clay/settings.py +++ b/clay/settings.py @@ -78,6 +78,12 @@ class _Settings(object): self._config = yaml.load(settings_file.read()) def _commit_edits(self, config): + """ + Write config to file. + + This method is supposed to be called only + from :py:meth:`~._SettingsEditor.__exit__`. + """ self._config.update(config) with open(self._config_file_path, 'w') as settings_file: settings_file.write(yaml.dump(self._config, default_flow_style=False))