Apply suggestions from code review

Co-authored-by: Julia Sprenger <[email protected]>

Author: samuelgarcia

.github/workflows/full-test.yml

@@ -38,7 +38,7 @@ jobs:
           # needed for correct operation of git/git-annex/DataLad
           git config --global user.email "neo_ci@fake_mail.com"
           git config --global user.name "neo CI"
-          # create an environement and install everything
+          # create an environment and install everything
           python -m venv ~/test_env
           source ~/test_env/bin/activate
           python -m pip install --upgrade pip

neo/__init__.py

@@ -8,7 +8,6 @@
 logging_handler = logging.StreamHandler()
 
 from neo.core import *
-# import neo.rawio
 from neo.io import *
 
 from neo.version import version as __version__

neo/test/iotest/common_io_test.py

@@ -182,7 +182,7 @@ def get_local_base_folder(self):
     def get_local_path(self, sub_path):
         root_local_path = self.get_local_base_folder()
         local_path = root_local_path / sub_path
-        # TODO later : remove the str when all IOs handle the Path stuff
+        # TODO later : remove the str when all IOs handle the pathlib.Path objects
         local_path = str(local_path)
         return local_path
 

neo/test/rawiotest/common_rawio_test.py

@@ -30,7 +30,6 @@
 
 
 # url_for_tests = "https://portal.g-node.org/neo/" #This is the old place
-# url_for_tests = "https://web.gin.g-node.org/NeuralEnsemble/ephy_testing_data/raw/master/"
 repo_for_test = 'https://gin.g-node.org/NeuralEnsemble/ephy_testing_data'
 
 class BaseTestRawIO:
@@ -72,7 +71,7 @@ def get_local_base_folder(self):
     def get_local_path(self, sub_path):
         root_local_path = self.get_local_base_folder()
         local_path = root_local_path / sub_path
-        # TODO later : remove the str when all IOs handle the Path stuff
+        # TODO later : remove the str when all IOs handle the pathlib.Path objects
         local_path = str(local_path)
         return local_path
 

neo/test/rawiotest/test_examplerawio.py

@@ -31,11 +31,12 @@ class and a full test will be done to test if the new coded IO
 
 class TestExampleRawIO(BaseTestRawIO, unittest.TestCase, ):
     rawioclass = ExampleRawIO
-    # here obsvisously there is nothing to download:
+    # here obliviously there is nothing to download:
     entities_to_download = []
-    # here we will test 1 fake files
+
+    # here we will test 1 fake file
     # note that for IOs based on directory names you can put the directory
-    # name here instead of the file name.
+    # name here instead of the filename.
     entities_to_test = ['fake1']
 
 

neo/utils/datasets.py

@@ -1,5 +1,5 @@
 """
-Some simple function to retrieve public datasets.
+Utility functions to retrieve public datasets.
 """
 from pathlib import Path
 import os
@@ -48,6 +48,7 @@ def download_dataset(repo=None, remote_path=None, local_folder=None):
         The distant path to retrieve (file or folder)
     local_folder: str or Path or None
         The local folder where to download the data.
+        If None, a default project testing folder is used. Default: None
 
     Returns:
     --------