-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move generated docs test to other file
- Loading branch information
1 parent
6ab91f9
commit e691b26
Showing
2 changed files
with
43 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
expected_extended_help = """# Extended help | ||
## Mandatory keys: | ||
* `neutral_check`: | ||
* neutral stable | ||
* `multiplication_check`: | ||
* multiplication stable | ||
* `inversion_check`: | ||
* inversion stable | ||
* inversion works""" | ||
|
||
@test strip(Interfaces._extended_help(Group.GroupInterface)) == strip(expected_extended_help) | ||
|
||
|
||
expected_docs = """``` | ||
GroupInterface | ||
``` | ||
An Interfaces.jl `Interface` with mandatory components `(:neutral_check, :multiplication_check, :inversion_check)` and optional components `()`. | ||
A group is a set of elements with a neutral element where you can perform multiplications and inversions. | ||
The conditions checking the interface accept an `Arguments` object with two fields named `x` and `y`. The type of the first field `x` must be the type you wish to declare as implementing `GroupInterface`. | ||
# Extended help | ||
## Mandatory keys: | ||
* `neutral_check`: | ||
* neutral stable | ||
* `multiplication_check`: | ||
* multiplication stable | ||
* `inversion_check`: | ||
* inversion stable | ||
* inversion works""" | ||
|
||
@test strip(string(@doc Group.GroupInterface)) == strip(expected_docs) | ||
|