Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Cloogle
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
Operations
Operations
Incidents
Analytics
Analytics
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Cloogle
Cloogle
Commits
395f0b04
Verified
Commit
395f0b04
authored
Sep 08, 2018
by
Camil Staps
🚀
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Remove outdated information about property documentation from readme
parent
64a2efb9
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
4 additions
and
21 deletions
+4
-21
README.md
README.md
+4
-21
No files found.
README.md
View file @
395f0b04
...
...
@@ -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 & License
Copyright
©
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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment