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

Allow overriding of docstrings for schema documentation #1837

Open
StevenMaude opened this issue Dec 13, 2023 · 0 comments
Open

Allow overriding of docstrings for schema documentation #1837

StevenMaude opened this issue Dec 13, 2023 · 0 comments

Comments

@StevenMaude
Copy link
Contributor

Sometimes tables are reused in a schema other than where they were added. This can lead to the quirk of documentation written for the intended schema having incorrect references when that table is reused elsewhere.

For example, as noted in #1821, the emis schema uses the ons_deaths table from core. And the raw.emis schema uses the ons_deaths table from raw.core.

In both of these docstrings, the raw.core.ons_deaths table is referred to. This is correct for the core schema. But not the emis schema, which has raw.emis.ons_deaths. The actual underlying tables are identical, which is fine, but this doesn't show the canonically correct import: we prefer to not mix imports from different schemas (core, tpp, emis).

An image showing a preview of the EMIS schema documentation for ehrQL. The schema name and the tables.raw.core.ons.deaths import are highlighted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant