Skip to content

Conversation

@bendhouseart
Copy link
Collaborator

@bendhouseart bendhouseart commented Aug 21, 2025

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

@codecov
Copy link

codecov bot commented Aug 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.71%. Comparing base (870afc6) to head (0333893).
⚠️ Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@effigies effigies added schema Issues related to the YAML schema representation of the specification. Patch version release. exclude-from-changelog This item will not feature in the automatically generated changelog documentation labels Sep 5, 2025
Copy link
Member

@julia-pfarr julia-pfarr left a 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:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.
Copy link
Member

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?

@effigies
Copy link
Collaborator

@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.

@effigies
Copy link
Collaborator

effigies commented Oct 2, 2025

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?

@effigies
Copy link
Collaborator

effigies commented Oct 2, 2025

Rejiggered the table a little, just in case you want to have a last look.

@effigies effigies marked this pull request as ready for review October 2, 2025 20:30
@effigies effigies requested a review from erdalkaraca as a code owner October 2, 2025 20:30
@effigies
Copy link
Collaborator

effigies commented Oct 2, 2025

Eh. We can always make it better in the future.

@effigies effigies merged commit bfba949 into master Oct 2, 2025
27 checks passed
@effigies effigies deleted the update-schema-docs branch October 2, 2025 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation exclude-from-changelog This item will not feature in the automatically generated changelog schema Issues related to the YAML schema representation of the specification. Patch version release.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants