Skip to content

Commit 9cb7c81

Browse files
authored
added missing ticks in docstring (#175)
* added missing ticks in docstring * added link to webpage in readme (fixes #151) * fix docstring for constraint-macro (fixes #154)
1 parent a3827dc commit 9cb7c81

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# IntervalConstraintProgramming.jl
22

33
[![Build Status](https://travis-ci.org/JuliaIntervals/IntervalConstraintProgramming.jl.svg?branch=master)](https://travis-ci.org/dpsanders/IntervalConstraintProgramming.jl)
4+
[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaintervals.github.io/pages/packages/intervalconstraintprogramming/)
45

56
This Julia package allows us to specify a set of constraints on real-valued variables,
67
given by inequalities, and
@@ -12,9 +13,9 @@ The package is based on interval arithmetic using the
1213
in particular multi-dimensional `IntervalBox`es (i.e. Cartesian products of one-dimensional intervals).
1314

1415
## Documentation
15-
Documentation for the package is available [here](http://juliaintervals.github.io/IntervalConstraintProgramming.jl/latest/).
16+
Documentation for the package is available [here](https://juliaintervals.github.io/pages/packages/intervalconstraintprogramming/).
1617

17-
The best way to learn how to use the package is to look at the example notebooks, available in a separate repository [here](https://github.com/JuliaIntervals/IntervalConstraintProgrammingNotebooks).
18+
The best way to learn how to use the package is to look at the tutorial, available in the organisation webpage [here](https://juliaintervals.github.io/pages/tutorials/tutorialConstraintProgramming/).
1819

1920

2021
## Author

src/separator.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ External constants can be used as e.g. `\$a`:
178178
179179
```
180180
a = 3
181-
C = @constraint x^2 + y^2 <= \$a
181+
C = @constraint x^2 + y^2 - \$a <= 0
182182
```
183183
"""
184184
macro constraint(ex::Expr, variables = [])
@@ -190,10 +190,13 @@ end
190190
"""
191191
Create a separator without the use of macros using ModelingToolkit
192192
193-
e.g vars = @variables x y z
193+
e.g
194+
```
195+
vars = @variables x y z
194196
S = Separator(vars, x^2+y^2<1)
195197
X= IntervalBox(-0.5..1.5, -0.5..1.5, -0.5..1.5)
196198
S(X)
199+
```
197200
"""
198201
function Separator(variables, ex::Operation)
199202
expr, constraint = parse_comparison(ex)

0 commit comments

Comments
 (0)