Skip to content

Commit cafd40e

Browse files
authored
Update documentation: new images, better links to API. (#591)
* Update images. * Set functions to API links. * Update images.
1 parent 4ef3d58 commit cafd40e

33 files changed

Lines changed: 51 additions & 44 deletions

datashuttle/datashuttle_class.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1077,7 +1077,17 @@ def make_config_file(
10771077
ds_logger.close_log_filehandler()
10781078

10791079
def update_config_file(self, **kwargs) -> None:
1080-
"""Update the configuration file."""
1080+
"""Update the configuration file.
1081+
1082+
Parameters
1083+
----------
1084+
**kwargs
1085+
A dictionary of key-value pairs containing the config
1086+
settings to update. For example,
1087+
``{"connection_method": "local_filesystem", "central_path": "/my/local/path"}``
1088+
will update the ``connection_method`` and ``central_path`` settings.
1089+
1090+
"""
10811091
if not self.cfg:
10821092
utils.log_and_raise_error(
10831093
"Must have a config loaded before updating configs.",
-381 KB
Loading
-392 KB
Loading
-208 KB
Loading
-203 KB
Loading
-206 KB
Loading
-199 KB
Loading
-428 KB
Loading
-562 KB
Loading
-723 Bytes
Loading

0 commit comments

Comments
 (0)