From d9eeb6d3606b1e52ee1282b09a581aab93273395 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Mon, 4 Apr 2022 16:50:56 +0200 Subject: [PATCH] [MISC] consistently use "directory" instead of "folder" as a term (#1044) * sub-directory -> subdirectory * [fF]older[s]{0,1} --> [dD]irector[yies]* * ci: bump GH actions * markdown: fix table pipes --- .github/workflows/codespell.yml | 2 +- .github/workflows/markdown_style.yml | 2 +- .github/workflows/no-bad-latin.yml | 4 +- .github/workflows/schemacode_ci.yml | 10 ++--- .github/workflows/yml_lint.yml | 4 +- CONTRIBUTING.md | 4 +- macros_doc.md | 8 ++-- src/01-introduction.md | 2 +- src/02-common-principles.md | 44 +++++++++---------- src/03-modality-agnostic-files.md | 4 +- .../01-magnetic-resonance-imaging-data.md | 2 +- .../02-magnetoencephalography.md | 6 +-- .../04-intracranial-electroencephalography.md | 2 +- .../05-task-events.md | 10 ++--- .../07-behavioral-experiments.md | 6 +-- .../10-microscopy.md | 2 +- src/99-appendices/06-meg-file-formats.md | 20 ++++----- src/99-appendices/11-qmri.md | 10 ++--- src/CHANGES.md | 8 ++-- src/schema/README.md | 34 +++++++------- src/schema/objects/associated_data.yaml | 12 ++--- src/schema/objects/columns.yaml | 4 +- src/schema/objects/formats.yaml | 16 +++---- src/schema/objects/metadata.yaml | 4 +- src/schema/rules/associated_data.yaml | 4 +- tools/examplecode/example.py | 4 +- tools/filetree_example.ipynb | 8 ++-- tools/mkdocs_macros_bids/macros.py | 6 +-- tools/schemacode/schemacode/render.py | 4 +- tools/schemacode/schemacode/schema.py | 4 +- .../schemacode/tests/test_schema.py | 2 +- tools/schemacode/schemacode/utils.py | 4 +- 32 files changed, 128 insertions(+), 128 deletions(-) diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 3609c21cfd..db5f92e7d6 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: codespell-project/actions-codespell@master with: skip: js,*.svg diff --git a/.github/workflows/markdown_style.yml b/.github/workflows/markdown_style.yml index 578c6e8cf5..ecc5d6403f 100644 --- a/.github/workflows/markdown_style.yml +++ b/.github/workflows/markdown_style.yml @@ -6,7 +6,7 @@ jobs: markdown-style: runs-on : ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Setup NodeJS uses: actions/setup-node@v2 with: diff --git a/.github/workflows/no-bad-latin.yml b/.github/workflows/no-bad-latin.yml index 8a67e45ae3..da5bf72ac7 100644 --- a/.github/workflows/no-bad-latin.yml +++ b/.github/workflows/no-bad-latin.yml @@ -31,10 +31,10 @@ jobs: # This section collects together the steps involved in running the test steps: # Checkout the repository. Relies on another GH-Action. - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 # Set up the Python version. Relies on another GH-Action. - name: Setup Python 3.7 - uses: actions/setup-python@v1 + uses: actions/setup-python@v3 with: python-version: 3.7 # Install Python dependencies diff --git a/.github/workflows/schemacode_ci.yml b/.github/workflows/schemacode_ci.yml index 51f0334e5a..2bcb2c96d3 100644 --- a/.github/workflows/schemacode_ci.yml +++ b/.github/workflows/schemacode_ci.yml @@ -20,7 +20,7 @@ jobs: outputs: skip: ${{ steps.result_step.outputs.ci-skip }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: fetch-depth: 0 - id: result_step @@ -43,10 +43,10 @@ jobs: run: shell: bash steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: "Set up Python" - uses: actions/setup-python@v2 + uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} @@ -74,10 +74,10 @@ jobs: name: Lint schemacode steps: - name: Check out source repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Python environment - uses: actions/setup-python@v2 + uses: actions/setup-python@v3 with: python-version: "3.7" diff --git a/.github/workflows/yml_lint.yml b/.github/workflows/yml_lint.yml index 9f5609afa6..99e534c78b 100644 --- a/.github/workflows/yml_lint.yml +++ b/.github/workflows/yml_lint.yml @@ -6,9 +6,9 @@ jobs: yml-lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python - uses: actions/setup-python@v1 + uses: actions/setup-python@v3 with: python-version: 3.9 - name: Install dependencies diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 807f7f345a..a8f740e19b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -415,7 +415,7 @@ specification, do not hesitate to make a suggestion by showing a draft in a GitH After discussion and approval by the community, you can then submit your image in a pull request. -Images should be added to an `images` folder that is at the same level as the Markdown file +Images should be added to an `images` directory that is at the same level as the Markdown file where your image will be added. For example if you want to add a figure `figure01.png` to `src/05-derivatives/01-introduction.md` then your image should go to `src/05-derivatives/images/figure01.png`. @@ -629,7 +629,7 @@ reviewer as a co-author. ## Making a change to the BIDS-schema Several aspects of the specification are defined in a set of YAML files in the -`src/schema` folder. The content of those files is described in a dedicated +`src/schema` directory. The content of those files is described in a dedicated [README file](./src/schema/README.md). ### 1. Ensure that changes to the specification are matched in the schema diff --git a/macros_doc.md b/macros_doc.md index b130b961cd..c202891717 100644 --- a/macros_doc.md +++ b/macros_doc.md @@ -17,7 +17,7 @@ in the BIDS specification. - [Do I need learn how to program to use those macros?](#do-i-need-learn-how-to-program-to-use-those-macros) - [Anything else I need to know if I need to insert a new macro call?](#anything-else-i-need-to-know-if-i-need-to-insert-a-new-macro-call) - [How-To and Examples](#how-to-and-examples) - - [Writing folder content examples](#writing-folder-content-examples) + - [Writing directory content examples](#writing-directory-content-examples) - [Generating tables](#generating-tables) - [Modifying a term in the table](#modifying-a-term-in-the-table) - [Why would you NOT want to modify the content of the yml file directly ?](#why-would-you-not-want-to-modify-the-content-of-the-yml-file-directly-) @@ -113,7 +113,7 @@ correct terms in the schema. This process is illustrated in the next section. Note that under the hood the macros themselves call python code that can be found in the -[`tools` folder](https://github.com/bids-standard/bids-specification/tree/master/tools). +[`tools` directory](https://github.com/bids-standard/bids-specification/tree/master/tools). If you are interested in creating a new macro for users, this would be useful. ## Anything else I need to know if I need to insert a new macro call? @@ -146,7 +146,7 @@ and a guide for editing at . ## How-To and Examples -### Writing folder content examples +### Writing directory content examples One of the simplest macro we use helps us create consistent "file tree" examples that would look like this in the final document: @@ -173,7 +173,7 @@ To do this get this output, your macro call would look like this: ) }} ``` -When you have complex files and folder structure, we suggest you use this +When you have complex files and directory structure, we suggest you use this [Jupyter notebook](tools/filetree_example.ipynb) for sandboxing your example before you insert the macro call into the markdown document. diff --git a/src/01-introduction.md b/src/01-introduction.md index 507a1fd74c..f3342ba00a 100644 --- a/src/01-introduction.md +++ b/src/01-introduction.md @@ -40,7 +40,7 @@ and the INCF Neuroimaging Data Sharing (NIDASH) Task Force. While working on BIDS we consulted many neuroscientists to make sure it covers most common experiments, but at the same time is intuitive and easy to adopt. The specification is intentionally -based on simple file formats and folder structures to reflect current lab +based on simple file formats and directory structures to reflect current lab practices and make it accessible to a wide range of scientists coming from different backgrounds. diff --git a/src/02-common-principles.md b/src/02-common-principles.md index ec2c4aba5a..ca238fa64c 100644 --- a/src/02-common-principles.md +++ b/src/02-common-principles.md @@ -140,7 +140,7 @@ T2 volume does not need to be included, but when it is available it should be saved under a particular filename specified in the standard. This standard aspires to describe a majority of datasets, but acknowledges that there will be cases that do not fit. In such cases one can include additional files and -subfolders to the existing folder structure following common sense. For example +subdirectories to the existing directory structure following common sense. For example one may want to include eye tracking data in a vendor specific format that is not covered by this standard. The most sensible place to put it is next to the continuous recording file with the same naming scheme but different extensions. @@ -156,7 +156,7 @@ Two prominent examples of entities are `subject` and `session`. For a data file that was collected in a given `session` from a given `subject`, the filename MUST begin with the string `sub-