Repository navigation
Conversation
render_spec_doc() printed each field table without a trailing newline, so the next table heading followed "</table>" on the same line. The visit_occurrence.visit_end_date ETL conventions contain a markdown list, and after that table the VISIT_DETAIL heading was not parsed as its own section, so it was missing from the left-hand table of contents on the v5.3, v5.4 and v5.5 pages. Emit a blank line after each table so every table heading starts a new block, and update the rendered cdm53, cdm54 and cdm55 pages. Fixes OHDSI#813
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #813
VISIT_DETAIL is rendered on the v5.5 specification page but is missing from the left-hand "On this page" menu between VISIT_OCCURRENCE and CONDITION_OCCURRENCE. The same happens on the v5.3 and v5.4 pages.
Cause
render_spec_doc()insite/R/specDocRenderer.Rprints each field table withprint(table_html), which does not end with a newline, so in the knitted markdown the next heading follows</table>on the same line:This is usually harmless, but the
visit_occurrence.visit_end_dateETL conventions contain a markdown list. After that table the VISIT_DETAIL heading is not parsed as its own section: it is emitted as a bare<h3 id="visit_detail">inside the VISIT_OCCURRENCE section, so Quarto leaves it out of the TOC.Change
site/R/specDocRenderer.R: write a blank line after each printed table, so every table heading starts a new block.docs/cdm53.html,docs/cdm54.html,docs/cdm55.html: the rendered result. In each page, VISIT_DETAIL gets its own<section id="visit_detail">and a TOC entry. Nothing else changes. To keep the diff small, I applied only the lines that changed between renders before and after the fix, and left out the unrelated Quarto version and CSS hash changes from my local render.docs/search.jsonchanges only by whitespace in the "Clinical Data Tables" entries, so I did not touch it.Testing
I rendered
cdm53.qmd,cdm54.qmd,cdm55.qmdandcdm60.qmdwith Quarto 1.10.19 before and after the change:After the change, every table in each Table_Level CSV has its own section (37, 39, 42 and 38 tables). The before/after HTML diff is limited to the VISIT_DETAIL TOC entry and section wrapper. cdm60 renders identically. The package tests (
tests/testthat) still pass. They do not coversite/.