Skip to content

Commit

Permalink
updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
a-hartens committed Nov 20, 2024
1 parent a625940 commit a0b5768
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/api/phenotypes/continuous_coverage_phenotype.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# ContinuousCoveragePhenotype

::: phenex.phenotypes.continuous_coverage_phenotype
::: phenex.phenotypes.continuous_coverage_phenotype.ContinuousCoveragePhenotype
2 changes: 1 addition & 1 deletion docs/api/phenotypes/sex_phenotype.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# SexPhenotype

::: phenex.phenotypes.sex_phenotype
::: phenex.phenotypes.sex_phenotype.SexPhenotype
3 changes: 3 additions & 0 deletions phenex/phenotypes/phenotype.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ def execute(self, tables: Dict[str, Table]) -> PhenotypeTable:
Args:
tables (Dict[str, Table]): A dictionary of table names to Table objects.
Returns:
PhenotypeTable: The resulting phenotype table containing the required columns.
Raises:
ValueError: If the table returned by _execute() does not contain the required phenotype
columns.
Expand All @@ -70,6 +72,7 @@ def namespaced_table(self) -> Table:
The phenotype.table has columns 'person_id', 'boolean', 'event_date', and 'value'. The namespaced_table
appends the phenotype name to all of these columns. This is useful when joining multiple phenotype tables
together
Returns:
Table: The namespaced table for the current phenotype.
"""
Expand Down

0 comments on commit a0b5768

Please sign in to comment.