bids-specification icon indicating copy to clipboard operation
bids-specification copied to clipboard

[MISC] Sort subsections within sections alphabetically

Open yarikoptic opened this issue 2 years ago • 3 comments

I was feeling the need for it each time I was navigating BIDS, but seeing https://github.com/bids-standard/bids-specification/pull/1128/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2 suggesting the same made me propose it.

I think having subsections sorted where there is no really really a requirement for order helps visitor to navigate the document/website instead of doing linear search among all subsections.

yarikoptic avatar Dec 08 '22 14:12 yarikoptic

Fine as is for me but always wondering if we should not put a comment in the yml saying that those sub sections are ordered alphabetrically.

I rebased and added a comment for each of those sections. AFAIK comments are ok for yaml so hopefully it would not break any workflow. Check it out

yarikoptic avatar Jan 18 '23 16:01 yarikoptic

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (1c6cc99) 88.65% compared to head (d446ab2) 88.65%. Report is 383 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1366   +/-   ##
=======================================
  Coverage   88.65%   88.65%           
=======================================
  Files          11       11           
  Lines        1084     1084           
=======================================
  Hits          961      961           
  Misses        123      123           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 18 '23 16:01 codecov[bot]