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

[DISCUSSION] Redundancy in the specification #1194

Open
Remi-Gau opened this issue Aug 10, 2022 · 1 comment
Open

[DISCUSSION] Redundancy in the specification #1194

Remi-Gau opened this issue Aug 10, 2022 · 1 comment
Labels
discussion ongoing discussion

Comments

@Remi-Gau
Copy link
Collaborator

Open-ended discussion to see how people feel about the presence of redundancy in the specification.

For a bunch of reasons (how the specifcation got built, how each datatype section aims to be more "standalone"...) there is a certain amount of redundancy in the specification. That comes with pros and cons (that may be different for readers and maintainers).

That being said, I wonder if some redundancy could not be removed.

One example from https://bids-specification.readthedocs.io/en/stable/04-modality-specific-files/01-magnetic-resonance-imaging-data.html#task-including-resting-state-imaging-data

The following passage just re-explains the inheritance principle without mentioning.

If this information is the same for all participants, sessions and runs it can be provided in task-_bold.json (in the root directory of the dataset). However, if the information differs between subjects/runs it can be specified in the sub-/func/sub-_task-[_acq-][_run-]_bold.json file. If both files are specified fields from the file corresponding to a particular participant, task and run takes precedence.

I would be tempted this paragraph because of its redundant character. Others may feel otherwise as it gives an in-context short concrete "example" of the inheritance principle. However other datatypes do not get similar example so it feels very uneven on the whole and feels like it'd be simpler to not have this example at all.

This is just one random snippet of something that occurs in several places in the spec.

Would be curious how people feel about this?

@Remi-Gau Remi-Gau added the discussion ongoing discussion label Aug 10, 2022
@sappelhoff
Copy link
Member

I think we can remove redundancy on a case-by-case basis, one PR at a time. If we concisely explain principles and use cross-links, then this should not impede the reading flow by too much (maybe on the contrary).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion ongoing discussion
Projects
None yet
Development

No branches or pull requests

2 participants