Ver código fonte

Small edits to README

sfmig 1 ano atrás
pai
commit
20a80e9587
1 arquivos alterados com 5 adições e 7 exclusões
  1. 5 7
      README.md

+ 5 - 7
README.md

@@ -15,12 +15,10 @@ test_data/test_<module-name>/
 
 This will allow us to make efficient use of the `pooch` library and the `pytest` fixtures.
 
-IMPORTANT: Please ensure that the filenames are unique across the whole test data repository.
+IMPORTANT: Please ensure that the filenames are unique across the whole test data repository. This is because during testing, we currently use the files' names as keys to access the data, and having duplicate names will cause (silent) conflicts.
 
 ### Steps
-Remember to update the file registry at `files-registry.txt` after adding or editing the data! 
-
-To do so, run the following from the root of the GIN repository:
+Remember to update the file registry at `files-registry.txt` after adding or editing any data. To do so, run the following from the root of the GIN repository:
 
 **1.** Ensure all the content is downloaded locally:
 
@@ -28,7 +26,7 @@ To do so, run the following from the root of the GIN repository:
 gin download --content
 ```
 
-**2.** After editing or adding any files, run the provided Python script to re-generate the `file-registry.txt` file:
+**2.** After editing or adding files, run the provided Python script to re-generate the `file-registry.txt` file:
 
 ```bash
 python get_sha256_hashes.py
@@ -37,8 +35,8 @@ python get_sha256_hashes.py
 **3.** Commit and upload the changes to the GIN repository
 
 ```bash
-gin commit -m "Update file and file-registry.txt" <path-to-edited-or-updated-file> file-registry.txt
-gin upload <path-to-edited-or-updated-file> file-registry.txt
+gin commit -m "Update file and file-registry.txt" <path-to-edited-file> file-registry.txt
+gin upload <path-to-edited-file> file-registry.txt
 ```
 
 For more details on how to work with GIN data repositories, please see the [GIN HowTo guide](https://howto.neuroinformatics.dev/open_science/GIN-repositories.html).