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.

Sign up for GitHub

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

Jump to bottom

Fix reference rendering in HTML report #986

Closed
handwerkerd opened this issue Oct 19, 2023 · 4 comments · Fixed by #1001
Closed

Fix reference rendering in HTML report #986

handwerkerd opened this issue Oct 19, 2023 · 4 comments · Fixed by #1001
Labels
bug issues describing a bug or error found in the project effort: medium Theoretically <40h total work good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function priority: medium Should get addressed soon reports issues related to boilerplate generation or visual reports

Comments

@handwerkerd
Copy link
Member

Summary

In tedana_report.html files LaTeX formatting for references are not rendering correctly.

Additional Detail

For example, see https://me-ica.github.io/ohbm-2023-multiecho/tedana/tedana_results_kundu_five-echo/tedana_report.html
The raw LaTeX typesetting appears in the HTML
@handwerkerd handwerkerd added bug issues describing a bug or error found in the project good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. reports issues related to boilerplate generation or visual reports priority: medium Should get addressed soon effort: medium Theoretically <40h total work impact: low Improving code/documentation cleanliness/clarity, not function labels Oct 19, 2023
@eurunuela
Copy link
Collaborator

Was it always like that?

I may be wrong but something tells me this is new after #875?

@eurunuela eurunuela mentioned this issue Oct 20, 2023
Open
2 tasks
@handwerkerd
Copy link
Member Author

I just opened up some reports from May 2022 (before #875 on Aug 12, 2022) and they were rendered correctly and some reports from November 2022 were not rendered correctly. I have some in Sept 2022 which were rendered correctly, but I was messing with versions as part of decision tree modularization so I'm not sure those used the updated main as of Sept 2022. The only other merged PR in those months that could have possible changed this was #818 but I just ran the tests with Python 3.9 and it still had these rendering issues. This is a long way of saying you're probably right regarding #875.

@eurunuela eurunuela mentioned this issue Nov 22, 2023
Merged
@crewalsh
Copy link

@eurunuela I poked around a bit to see if there was an easy option to fix the in-text citations in the report using pybtex (or any other package), but couldn't seem to find an easy solution. Have you had time to look at this any further? I think it might be possible to fix with some regex, but didn't want to re-invent the wheel if you've already had luck with this.

@eurunuela
Copy link
Collaborator

Hey @crewalsh , I haven't had much time but I think I may be able to work on it today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug issues describing a bug or error found in the project effort: medium Theoretically <40h total work good first issue issues that we think are good for new contributors. Equivalent to "very low" effort. impact: low Improving code/documentation cleanliness/clarity, not function priority: medium Should get addressed soon reports issues related to boilerplate generation or visual reports
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix Bibtex rendering in reports eurunuela/tedana
3 participants
@handwerkerd @eurunuela @crewalsh