-
Notifications
You must be signed in to change notification settings - Fork 165
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
Derivatives: desc-
to be the last entity when used?
#1895
Comments
In a way we are exicit about it here. https://github.com/bids-standard/bids-specification/blob/master/src%2Fschema%2Frules%2Fentities.yaml But we have nothing in the metaschema that says that description must be the last entity. |
+1 I would be in favor of making this explicit. |
isn't
making it is as explicit as it can get insofar in the metaschema? |
I will propose a quick PR to make it verbalized to human readers of the spec: #1915 |
I believe the question is whether we want to prospectively declare that no future entity may come after desc. Personally, I think it should remain the last, but I'm not sure it's a great idea to foreclose on the possibility of ever putting something after it. And just a note about that list: It is one of many possible topological sorts for the entities in existing file rules. It could potentially be reshuffled as long as it doesn't change the ordering for a file rule that already exists. |
I think we can treat it as a strong recommendation for PRs and BEPs to retain |
In a conversation about diffusion derivatives @tsalo pointed out that in our development of BEP16, we have a
desc-
entity, followed byparam-
entity (see: https://github.com/bids-standard/bids-bep016/pull/24/files). He thought this was inelegant and pointed out that in other places (e.g., https://bids-specification--519.org.readthedocs.build/en/519/derivatives/functional-derivatives.html#functional-derivatives-maps), there is an understanding that thedesc-
entity is the last one to be used before the suffix. I wonder whether others feel similarly and whether we want to be explicit about this, e.g., here:bids-specification/src/schema/objects/entities.yaml
Line 68 in b91d0e3
The text was updated successfully, but these errors were encountered: