[ENH] use schema to mention which "top directories" are allowed

[Remi-Gau]

closes #1284

• [x] update macro doc

[codecov[bot]]

Codecov Report

Base: 88.33% // Head: 88.39% // Increases project coverage by +0.06% :tada:

Coverage data is based on head (4da60fa) compared to base (1053ce4). Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1289      +/-   ##
==========================================
+ Coverage   88.33%   88.39%   +0.06%     
==========================================
  Files          11       11              
  Lines        1080     1086       +6     
==========================================
+ Hits          954      960       +6     
  Misses        126      126              

Impacted Files	Coverage Δ
...ools/schemacode/bidsschematools/render/__init__.py	100.00% <ø> (ø)
tools/schemacode/bidsschematools/render/text.py	97.47% <100.00%> (+0.07%)	:arrow_up:

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

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[Remi-Gau]

@VisLab

Is that what you had in mind?

https://bids-specification--1289.org.readthedocs.build/en/1289/02-common-principles.html#other-top-level-directories

[Remi-Gau]

Another would be useful would be to add internal links to the sections of specs that relate to each directory.

[VisLab]

Perfect!

On Fri, Sep 16, 2022 at 3:58 PM Remi Gau @.***> wrote:

@VisLab https://github.com/VisLab

Is that what you had in mind?

https://bids-specification--1289.org.readthedocs.build/en/1289/02-common-principles.html#other-top-level-directories

— Reply to this email directly, view it on GitHub https://github.com/bids-standard/bids-specification/pull/1289#issuecomment-1249809576, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJCJOVIYKD7HA5QMKO6HLDV6TNN3ANCNFSM6AAAAAAQOU5LYU . You are receiving this because you were mentioned.Message ID: @.***>

[Remi-Gau]

Another would be useful would be to add internal links to the sections of specs that relate to each directory.

Done

[effigies]

@Remi-Gau Is this high priority, as in you want to get it in for the release? Trying to decide when to review this.

[Remi-Gau]

not high priority IMHO @VisLab do you agree?

[VisLab]

No it's not a high priority, but I think it should go in at some point. Thanks...

On Tue, Sep 20, 2022 at 8:55 AM Remi Gau @.***> wrote:

not high priority IMHO @VisLab https://github.com/VisLab do you agree?

— Reply to this email directly, view it on GitHub https://github.com/bids-standard/bids-specification/pull/1289#issuecomment-1252392382, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJCJORLYYH6AH75YIPC7PTV7G66VANCNFSM6AAAAAAQOU5LYU . You are receiving this because you were mentioned.Message ID: @.***>

[Remi-Gau]

I think that anyway @effigies has a pr in the pipeline (#1288 ) that will wreck a lot of how this work even if this does not change the final output so I am waiting for this one to be in and adapt from there.

[sappelhoff]

I think that anyway effigies has a pr in the pipeline that will wreck a lot of how this work even if this does not change the final output so I am waiting for this one to be in and adapt from there.

converting to draft then -- please link to that "PR in the pipeline" if you know where it exists :)

[Remi-Gau]

please link to that "PR in the pipeline" if you know where it exists :)

done

[effigies]

@Remi-Gau Conflicting #1288 has been merged.

[Remi-Gau]

@Remi-Gau Conflicting #1288 has been merged.

thanks for the ping

will update accordingly

[Remi-Gau]

Still need to add test but other than that we are back on track.

[Remi-Gau]

sometimes use sub-directories and other times subdirectories in the spe

Should we do a separate PR for this?

[sappelhoff]

Should we do a separate PR for this?

yes, I can do it, do you agree to always use the hyphen?

[VisLab]

@Remi-Gau Thanks for seeing this through.