Skip to content
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

[ENH] Add glossary links to all tables #1268

Merged
merged 13 commits into from
Sep 6, 2022

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Aug 31, 2022

I think this should close #1053.

This PR updates the rendering functions to link tables to the glossary.

What this covers:

  • suffixes in suffix tables
  • metadata fields in metadata tables, but not subfields in object tables
  • column names in column tables
  • data types and suffixes in entity tables

@tsalo tsalo added schema-code Updates or changes to the code used to parse, filter, and render the schema. formatting Aesthetics and formatting of the spec labels Aug 31, 2022
@codecov
Copy link

codecov bot commented Aug 31, 2022

Codecov Report

Merging #1268 (a921c13) into master (8b53807) will increase coverage by 0.35%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1268      +/-   ##
==========================================
+ Coverage   87.95%   88.30%   +0.35%     
==========================================
  Files           6        6              
  Lines        1038     1052      +14     
==========================================
+ Hits          913      929      +16     
+ Misses        125      123       -2     
Impacted Files Coverage Δ
tools/schemacode/bidsschematools/render.py 92.28% <100.00%> (+0.26%) ⬆️
tools/schemacode/bidsschematools/schema.py 82.75% <0.00%> (+1.37%) ⬆️

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

@tsalo tsalo marked this pull request as ready for review August 31, 2022 18:45
@tsalo tsalo requested review from effigies, sappelhoff and Remi-Gau and removed request for erdalkaraca September 1, 2022 16:31
Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

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

LGTM! The linking work in the recent PRs is really awesome @tsalo ... thanks a lot.

For other reviewers, checkout:

@sappelhoff sappelhoff added this to the 1.8.0 milestone Sep 1, 2022
@sappelhoff sappelhoff merged commit 5f59c94 into bids-standard:master Sep 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
formatting Aesthetics and formatting of the spec schema-code Updates or changes to the code used to parse, filter, and render the schema.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Documentation usability enhancement: give more items anchors for deep-linking
3 participants