formatting of REQUIRED, OPTIONAL arguments

[JoeZiminski]

In the BIDS specification, they format the REQUIRED, OPTIONAL in capitals. Personally I really dont like this, as caps are associated with shouting and in the form "you are REQUIRED to do this", I find it quite irksome. As it is inevitable some people will be annoyed at the proposed changes, I think this styling can make the frustration worse and would suggest using italics for this in our docs. However, this does break with the BIDS docs and maybe I am been too sensitive and no one else minds!

[adamltyson]

I agree with you. It does seem a bit shouty (unnecessarily in my view). Happy with italics for emphasis.

I also think that it's fine if we diverge when it comes to the style of the documentation.

[adamltyson]

Any thoughts @niksirbi @lauraporta?

[niksirbi]

I'm fine with italics. I think the intention behind the distinct formatting is to signal that these words have a specific meaning here, not a colloquial meaning. Eventually, if we want to be fancy, we could make some formatting rule on the website which automatically renders these keywords in distinct colours (e.g. with traffic light coding), but probably that's an overkill

[lauraporta]

I am fine with italics as well. I think they wanted to conform to a defined standard (RFC2119). I don't think it is that important for us. Niko, I like the idea of having custom colors!