Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
kabilar committed Dec 12, 2023
1 parent d8faac1 commit 2402f2c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions bids-validator/bids_validator/bids_validator.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,22 @@ def __init__(self, index_associated=True):
def is_bids(self, path):
"""Check if file path adheres to BIDS.
Main method of the validator. uses other class methods for checking
Main method of the validator. Uses other class methods for checking
different aspects of the file path.
Parameters
----------
path : str
Path of a file to be checked. Must be relative to root of a BIDS
dataset.
dataset, and must include a leading forward slash `/`.
Notes
-----
When you test a file path, make sure that the path is relative to the
root of the BIDS dataset the file is part of. That is, as soon as the
file path contains parts outside of the BIDS dataset, the validation
will fail. For example "home/username/my_dataset/participants.tsv" will
fail, although "participants.tsv" is a valid BIDS file.
fail, although "/participants.tsv" is a valid BIDS file.
Examples
--------
Expand Down

0 comments on commit 2402f2c

Please sign in to comment.