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

[ENH] Clarify that BIDS specification is in American English #1439

Merged
merged 4 commits into from
Mar 30, 2023

Conversation

yarikoptic
Copy link
Collaborator

@yarikoptic yarikoptic commented Mar 15, 2023

"Explicit is better than implicit." and the question of the spelling and syntax does come up from time to time, and ATM I observe BEPs prepared by European Colleagues are using British English in their documents.

Making it explicit would help to minimize possible tensions and required later work to prepare contributions into acceptable state.

I placed it first in the common principles since IMHO it is the shortest and most "basic" principle to agree upon before going into which words to use etc.

"Explicit is better than implicit." and question of the spelling does
come up from time to time, and ATM I observe BEPs prepared by European
Colleagues are using British English in their documents.

Making it explicit would help to minimize possible tensions and required
later work to prepare contributions into acceptable state.
@codecov
Copy link

codecov bot commented Mar 15, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.11 🎉

Comparison is base (19d6b65) 87.90% compared to head (78c54fe) 88.01%.

❗ Current head 78c54fe differs from pull request most recent head 00f90d3. Consider uploading reports for the commit 00f90d3 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1439      +/-   ##
==========================================
+ Coverage   87.90%   88.01%   +0.11%     
==========================================
  Files          14       14              
  Lines        1273     1268       -5     
==========================================
- Hits         1119     1116       -3     
+ Misses        154      152       -2     

see 1 file with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Co-authored-by: Stefan Appelhoff <[email protected]>
@sappelhoff sappelhoff added this to the 1.9.0 milestone Mar 16, 2023
@effigies
Copy link
Collaborator

Was this agreed by the SC? Could we get one more approval @guiomar @robertoostenveld @CPernet?

Along with #1444, it seems these could go in either the spec or the contributing guide. I'm slightly in favor of having spec-writing "principles" in the contributing guide as they have no effect on the interpretation of the spec or a dataset, but I would not attempt to block this.

@CPernet
Copy link
Collaborator

CPernet commented Mar 16, 2023

''I observe BEPs prepared by European Colleagues are using British English in their documents.'' yeh, if that was up to me I take British anytime ... but since you guys have way more contribution and besides India, the rest of Asia uses American English I guess you win -- SC has not discussed it, but it has my vote, so with Ariel that makes 3/5

Copy link
Collaborator

@robertoostenveld robertoostenveld left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve.

@sappelhoff
Copy link
Member

Along with #1444, it seems these could go in either the spec or the contributing guide. I'm slightly in favor of having spec-writing "principles" in the contributing guide as they have no effect on the interpretation of the spec or a dataset, but I would not attempt to block this.

I am fine with this going into the spec, but I see the point of why putting this into the contributing guide would make sense (even more so than it perhaps would for #1444)

https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md

If nobody objects within the next couple of days, I will transfer this change to the contributing guide and merge it.

@Remi-Gau
Copy link
Collaborator

I have a crazy suggestion: can we have it in both? (I usually don't like duplication but I may make an exception for this one.)

@yarikoptic
Copy link
Collaborator Author

I would vote strongly against transfer since that would invalidate the purpose of formalizing the language of the specification (as we have already for some special WORDS), and would vote "ok" for both.

@sappelhoff sappelhoff merged commit 65d37af into bids-standard:master Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants