Skip to content

Commit

Permalink
docs: Clarify example in homepage and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Abogical committed Aug 18, 2024
1 parent 4559123 commit 2cf6b8a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ This package is still a work in progress and not ready for release yet. A packag

### Example

Given the constraints $a < 3b$ and $c > b^2 + 1$:

```python
>>> from symconstraints import Constraints, symbols
>>> a, b, c = symbols('a b c')
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ mathematical expressions and infer all possible validation and imputation method

!!! example

Given the constraints $a < 3b$ and $c > b^2 + 1$:

```python
>>> from symconstraints import Constraints, symbols
>>> a, b, c = symbols('a b c')
Expand Down

0 comments on commit 2cf6b8a

Please sign in to comment.