search

neuroinformatics-unit / NeuroBlueprint

Lightweight data specification for systems neuroscience, inspired by BIDS.
http://neuroblueprint.neuroinformatics.dev/
Creative Commons Attribution 4.0 International
17 stars 1 forks source link

Datatype vs. data-type format between swc-blueprint and datashuttle docs. #27

Closed JoeZiminski closed 1 year ago

JoeZiminski commented 1 year ago

In SWC-Blueprint documentation data type is written datatype (when not in backticks). This makes nice consistency where it appears in backticks e.g. datatype. For datashuttle docs, I realised it is data-type, so would be nice to have this consistent across website.

It may make sense to remove datatype from backtick in the specification, as its not something that is written in real projects (e.g. unlike behav, ephys). I see in bids they use datatype during examples, so we could stick with this.

I think data-type is a little more readable, but datatype is nice as it is consistent with datatype examples in backticks, if we stick with them.

niksirbi commented 1 year ago

So how about we keep spelling it as datatype, same as BIDS, but I remove the backticks from datatype because you are right about it not appearing in the project tree. I am willing to implement this here and you can do the same for DataShuttle.

JoeZiminski commented 1 year ago

Perfect that makes sense.