Verified Commit 395f0b04 authored by Camil Staps's avatar Camil Staps 🙂

Remove outdated information about property documentation from readme

parent 64a2efb9
......@@ -113,26 +113,9 @@ do), `CloogleDBFactory` can derive the type.</sup>
### Property documentation
With [clean-test][]'s `maketest` tool, [Gast][] test programs can be generated
with properties from docblocks. For this, several additional fields can be
used, which are further documented by [clean-test][].
Briefly, `@property` on functions describes the actual property. When this uses
type variables, `@property-test-with` can be used to show how to instantiate
them. On the module, `@property-bootstrap` can be used to add bootstrap code,
like imports, to the top of the program. For example:
```clean
/**
* @property plus_commutative: A. x :: a; y :: a:
* x + y == y + x
* @property-test-with a = Int
* @property-test-with a = Real
*/
```
This will test the property `\x y -> x + y == y + x` where `x` and `y` are of
type `Int` or `Real`.
With [clean-test-properties][]' `testproperties` tool, [Gast][] test programs
can be generated with properties from docblocks. For this, several additional
fields can be used, which are further documented by [clean-test-properties][].
## Copyright &amp; License
Copyright &copy; 2016-present Mart Lubbers and Camil Staps.
......@@ -141,7 +124,7 @@ Licensed under MIT; See the [LICENSE](/LICENSE) file.
[Clean]: http://clean.cs.ru.nl
[Cloogle]: https://cloogle.org
[cocl]: https://svn.cs.ru.nl/repos/clean-compiler
[clean-test]: https://gitlab.science.ru.nl/clean-and-itasks/clean-test
[clean-test-properties]: https://gitlab.science.ru.nl/clean-and-itasks/clean-test-properties
[Gast]: https://gitlab.science.ru.nl/clean-and-itasks/gast
[y]: http://i.stack.imgur.com/iro5J.png
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment