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

[FIX] Use SPEC_ROOT/src_path in make_filename_template #1248

Merged
merged 1 commit into from
Aug 23, 2022

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Aug 23, 2022

Closes None, but fixes an error introduced in #1228.

Changes proposed:

  • Use relative paths in links to glossary and entities pages created by make_filename_template.

@tsalo tsalo added bug Something isn't working schema-code Updates or changes to the code used to parse, filter, and render the schema. exclude-from-changelog This item will not feature in the automatically generated changelog labels Aug 23, 2022
@tsalo tsalo requested a review from erdalkaraca as a code owner August 23, 2022 13:31
@tsalo tsalo requested review from effigies and removed request for erdalkaraca August 23, 2022 13:31
@tsalo
Copy link
Member Author

tsalo commented Aug 23, 2022

In the breaking build, internal links generated by make_filename_template are absolute paths (e.g., <a href="/99-appendices/14-glossary.html#anat-datatypes">anat</a>), while working links are relative paths, even after the markdown formatting (e.g., <a href="../99-appendices/09-entities.html#mod"><code>mod-&lt;label&gt;</code></a>).

With this fix, the make_filename_template-generated links are now relative (e.g., <a href="../99-appendices/14-glossary.html#anat-datatypes">anat</a>), so I think it should be good.

@codecov
Copy link

codecov bot commented Aug 23, 2022

Codecov Report

Merging #1248 (cc751a2) into master (ea25a5f) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #1248   +/-   ##
=======================================
  Coverage   88.23%   88.23%           
=======================================
  Files           6        6           
  Lines        1020     1020           
=======================================
  Hits          900      900           
  Misses        120      120           
Impacted Files Coverage Δ
tools/schemacode/bidsschematools/render.py 93.18% <100.00%> (ø)

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

@tsalo tsalo changed the title [FIX] Use SPEC_ROOT/src_path in make_filename_template. [FIX] Use SPEC_ROOT/src_path in make_filename_template Aug 23, 2022
Copy link
Collaborator

@effigies effigies left a comment

Choose a reason for hiding this comment

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

Looks good from my phone.

@tsalo
Copy link
Member Author

tsalo commented Aug 23, 2022

Cool. I'll merge it now and we'll see if it works!

@tsalo tsalo merged commit db4b0f5 into bids-standard:master Aug 23, 2022
@tsalo tsalo deleted the filename-srcpath branch August 23, 2022 15:46
@effigies
Copy link
Collaborator

Seems to be working.

@sappelhoff
Copy link
Member

Thanks for the quick fix!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working exclude-from-changelog This item will not feature in the automatically generated changelog 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.

3 participants