Skip to content

Commit

Permalink
Improve .cond and .contrast docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
grst committed Dec 14, 2024
1 parent 02be0f8 commit 48e201d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/formulaic_contrasts/_contrasts.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ def cond(self, **kwargs):
>>> contrast = model.cond(treatment="drugA") - model.cond(treatment="placebo")
For more information on how to build contrasts, see :doc:`/contrasts`.
Parameters
----------
**kwargs
Expand All @@ -68,7 +70,7 @@ def cond(self, **kwargs):

def contrast(self, column, baseline, group_to_compare):
"""
Build a simple contrast for pairwise comparisons.
Build a simple contrast for pairwise comparisons of a single variable.
For more complex contrasts, please use construct a contrast vector using
:func:`~formulaic_contrasts.FormulaicContrasts.cond`.
Expand Down

0 comments on commit 48e201d

Please sign in to comment.