Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] <matches> is sometimes used in templates but description in the glossary is missing #1748

Open
oesteban opened this issue Mar 24, 2024 · 2 comments · May be fixed by #1781
Open

[BUG] <matches> is sometimes used in templates but description in the glossary is missing #1748

oesteban opened this issue Mar 24, 2024 · 2 comments · May be fixed by #1781
Labels
bug Something isn't working documentation physio

Comments

@oesteban
Copy link
Collaborator

Describe your problem in detail.

Some parts of the spec employ the placeholder <matches> to refer to the entities that characterize a run or relevant subset of the dataset.

It feels like a reasonable way of making the spec clearer. I think the spec just misses that it was defined in the glossary.

Describe what you expected.

The definition of <matches> in the glossary, instead of every time it is used in a subsection of the spec.

BIDS specification section

Example of use:
https://bids-specification.readthedocs.io/en/stable/modality-specific-files/task-events.html

@Remi-Gau
Copy link
Collaborator

Along the same line, in you opinion, do you think it would make sense to also have the "source_entities" mentioned in the derivatives in the glossary?

https://bids-specification.readthedocs.io/en/latest/derivatives/introduction.html#file-naming-conventions

@oesteban
Copy link
Collaborator Author

oesteban commented Mar 26, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation physio
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

2 participants