[MISC] move schema documentation into the schema directory#740
[MISC] move schema documentation into the schema directory#740tsalo merged 3 commits intobids-standard:masterfrom
Conversation
|
FYI: the schema macro complains about the README when building the doc. I suspect this is expected given the python code expects only |
I've gotten similar complaints about |
Good idea. |
| Currently, the only portion of the specification that relies on this schema is | ||
| the Entity Table, but any changes to the specification should be mirrored in the | ||
| schema. |
There was a problem hiding this comment.
Not just the entity table, but also the entity definitions appendix and filename patterns throughout the specification.
There was a problem hiding this comment.
I was trying to see if I can do a pull request about this suggestion I made for renaming the entity field (to key) in the entity.yaml file. But I have a hard time to find all the places that would be affected by this change, can you perhaps tell me, how do I test this?
There was a problem hiding this comment.
I suspect most of the changes to be done there will be in the tools/schema_code, right @tsalo ?
Should we add a README into the tools folder with at least some very brief explanation of what to find in there?
There was a problem hiding this comment.
I agree that the code in that tools folder is where you will get the best idea of what parts of the schema are actively in use. It would be useful to add a README to that folder for right now, but I think we'll be moving that code into its own repository in the long run.
An alternative would be to focus on documenting the functions that are directly used in the specification (i.e., macros.py).
There was a problem hiding this comment.
OK I can try checking the code base and improving the doc strings.
Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>
Co-authored-by: Taylor Salo <tsalo006@fiu.edu>
33594e0 to
acda419
Compare
|
fyi @Remi-Gau, I applied Taylor's comments and rebased this on master so if you want to continue on this locally, you may want to run |
sappelhoff
left a comment
There was a problem hiding this comment.
If Taylor is happy with this, so am I, from my side, we can merge.
fixes #716