docs: add comment to TestIPFSToolDownload

valory-xyz · Dec 20, 2022 · 05e6949 · 05e6949
1 parent 152ff89
commit 05e6949
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/plugins/aea-cli-ipfs/tests/test_aea_cli_ipfs.py b/plugins/aea-cli-ipfs/tests/test_aea_cli_ipfs.py
@@ -193,6 +193,12 @@ def test_version_did_not_match():
 class TestIPFSToolDownload(CliTest):
     """Test IPFSTool.download"""
 
+    # we download either a file or a directory
+    # if a file: the original name is not preserved, and will be the hash
+    #   e.g. <filename> --> <some_ipfs_hash>
+    # if a dir : the original name is preserved, as a nested directory
+    #   e.g. <directory>/ --> <some_ipfs_hash>/<directory>/
+
     cli_options = ("ipfs", "download")
 
     def setup(self) -> None: