From 43b6a2e74848eb76af08543ce37c3175627407de Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Mon, 18 Sep 2023 16:25:31 -0400 Subject: [PATCH] [DATALAD RUNCMD] run codespell throughout fixing typo automagically === Do not change lines below === { "chain": [], "cmd": "codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- datashuttle/command_line_interface.py | 2 +- datashuttle/datashuttle.py | 2 +- docs/source/conf.py | 2 +- docs/source/pages/documentation.md | 2 +- tests/conftest.py | 2 +- tests/test_utils.py | 2 +- tests/tests_integration/test_command_line_interface.py | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/datashuttle/command_line_interface.py b/datashuttle/command_line_interface.py index aab59b24..ebf54b5b 100644 --- a/datashuttle/command_line_interface.py +++ b/datashuttle/command_line_interface.py @@ -1031,7 +1031,7 @@ def main() -> None: should match the datashuttle API function name. Next, initialise a datashuttle project using the API. - Supress the warning that a config file must + Suppress the warning that a config file must be made on project initialisation when a config is being made. diff --git a/datashuttle/datashuttle.py b/datashuttle/datashuttle.py index b4f687e6..9a288cdc 100644 --- a/datashuttle/datashuttle.py +++ b/datashuttle/datashuttle.py @@ -317,7 +317,7 @@ def upload( data type folder to upload. ses_names : a session name / list of session names, similar to - sub_names but requring a "ses-" prefix. + sub_names but requiring a "ses-" prefix. dry_run : perform a dry-run of upload. This will output as if file transfer was taking place, but no files will be moved. Useful diff --git a/docs/source/conf.py b/docs/source/conf.py index 78e4aa66..2b58a585 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -60,7 +60,7 @@ "substitution", "tasklist", ] -# Automatically add achors to markdown headings +# Automatically add anchors to markdown headings myst_heading_anchors = 3 # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/pages/documentation.md b/docs/source/pages/documentation.md index 89a0a4e8..4187831f 100644 --- a/docs/source/pages/documentation.md +++ b/docs/source/pages/documentation.md @@ -310,7 +310,7 @@ To discuss, contribute or give feedback on DataShuttle, please check out our dis ## Python API Guide -DataShuttle can be used through the command line interface (as exampled in the *Get Started* section) or through a Python API. All commands shown in the *Get Started* guide can be used similarly in the Python API (with hypens replaced by underscores). +DataShuttle can be used through the command line interface (as exampled in the *Get Started* section) or through a Python API. All commands shown in the *Get Started* guide can be used similarly in the Python API (with hyphens replaced by underscores). To start a project in Python, import DataShuttle and initialise the project class: diff --git a/tests/conftest.py b/tests/conftest.py index fdeae122..7233daad 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -10,7 +10,7 @@ FILESYSTEM_PATH and SERVER_PATH these must point to the same folder on the HPC, filesystem, -as a moutned drive and server as the linux path to +as a mounted drive and server as the linux path to connect through SSH """ import platform diff --git a/tests/test_utils.py b/tests/test_utils.py index ff5b5298..789a6c28 100644 --- a/tests/test_utils.py +++ b/tests/test_utils.py @@ -510,7 +510,7 @@ def get_top_level_folder_path( assert ( folder_name in canonical_folders.get_top_level_folders() - ), "folder_name must be cannonical e.g. rawdata" + ), "folder_name must be canonical e.g. rawdata" if local_or_central == "local": base_path = project.cfg["local_path"] diff --git a/tests/tests_integration/test_command_line_interface.py b/tests/tests_integration/test_command_line_interface.py index 665b68b0..712efcd3 100644 --- a/tests/tests_integration/test_command_line_interface.py +++ b/tests/tests_integration/test_command_line_interface.py @@ -279,7 +279,7 @@ def test_multiple_inputs(self, command): """ To process lists, a syntax "<>" is used to specify input is list. Check the passed - varialbes are processed as expected. + variables are processed as expected. """ stdout, stderr = test_utils.run_cli( f"{command} "