Skip to content

Commit

Permalink
Updated concepts within the rst files for the readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
brendanreardon committed Feb 15, 2025
1 parent 17af360 commit a00cd2b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions docs/source/concepts/catvrs_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,18 @@ description of a categorical variant.

.. include:: ../def/cat-vrs/CategoricalVariant.rst

.. _constraint:
.. _Constraint:

Constraint
##########

The *Constraint* class is an abstract class that is the parent of all
other constraint classes. A constraint is a rule or set of rules that
other constraint classes. A constraint is a rule or set of rules that
must be satisfied for a CategoricalVariant to be considered valid.
Constraint sub classes are only used in CategoricalVariant objects.

.. include:: ../def/cat-vrs/Constraint.rst

.. _DefiningAlleleConstraint:

DefiningAlleleConstraint
Expand Down
2 changes: 1 addition & 1 deletion docs/source/concepts/recipes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The ProteinSequenceConsequence is a :ref:`CategoricalVariant` with exactly one c
1. A :ref:`DefiningAlleleConstraint` with the `.relations` array containing only a
`translates_from` code. This constraint MUST refer to a protein variant for the `allele`.

.. _categorical-cnv:
.. _CategoricalCnv:

CategoricalCnv
!!!!!!!!!!!!!!
Expand Down

0 comments on commit a00cd2b

Please sign in to comment.