-
Notifications
You must be signed in to change notification settings - Fork 190
[SCHEMA][MISC][WIP] Update schema docs with BEP Google doc to schema examples. #2178
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
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2178 +/- ##
=======================================
Coverage 82.71% 82.71%
=======================================
Files 20 20
Lines 1608 1608
=======================================
Hits 1330 1330
Misses 278 278 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
julia-pfarr
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great! One additional suggestion: sometimes you use "you" and sometimes you use "we", I would use one of the two forms consistently.
| # Translating a BEP Document into Schema Code | ||
|
|
||
| One of the most important steps of a BEP is translating it from a plain text (google/microsoft document) as | ||
| a yaml schema. The yaml schema necessary for the following steps: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| a yaml schema. The yaml schema necessary for the following steps: | |
| a yaml schema. The yaml schema is necessary for the following steps: |
|
|
||
| For new modalities the first step should be to add that modality to the | ||
| [modalities.yaml](https://github.com/bids-standard/bids-specification/blob/880ab2db0570ff2038f403576f85564aa4454710/src/schema/objects/modalities.yaml) | ||
| file if it's not present. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is "if it's not present" necessary here? If it's a new modality it is for sure not present yet, no?
1ea9c1f to
297420b
Compare
4b231c3 to
1a51494
Compare
|
@bendhouseart I expanded the section you had a bit. LMK what you think. I'm worried I might have made it too dense for what you're going for. |
|
We can't expect further work from Anthony on this for the time being. @julia-pfarr do you want to have a look at it now? |
Co-authored-by: Julia-Katharina Pfarr <[email protected]>
|
Rejiggered the table a little, just in case you want to have a last look. |
|
Eh. We can always make it better in the future. |
Small update to schema docs to show how a google document is re-written into a schematized form, draft as it's a WIP.
Rendered: https://bidsschematools--2178.org.readthedocs.build/en/2178/doc_to_schema.html