Adding examples to the relations chapter #2219
Merged
Conversation
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
fingolfin
approved these changes
Feb 28, 2018
There was a problem hiding this comment.
Looks good to me, thanks!
Of course there are many more things that could be tested, e.g. IsEquivalenceRelation, IsSymmetricBinaryRelation, etc., e.g. via
gap> IsSymmetricBinaryRelation(BinaryRelationOnPoints([[2],[1]]));
true
gap> IsSymmetricBinaryRelation(BinaryRelationOnPoints([[2],[2]]));
false
But of course one can always do more, so that's not a complaint at all :-).
Let's see what the CI tests and codecov report then!
| ## <Example><![CDATA[ | ||
| ## gap> r:=BinaryRelationByElements(Domain([1..3]),[Tuple([1,2]),Tuple([1,3])]); | ||
| ## <general mapping: <object> -> <object> > | ||
| ## ]]></Example> | ||
| ## </Description> | ||
| ## </ManSection> |
There was a problem hiding this comment.
How about also adding an example for EmptyBinaryRelation, e.g.
gap> EmptyBinaryRelation(3) = BinaryRelationOnPoints([ [], [], [] ]);
true
There was a problem hiding this comment.
Hi @fingolfin , thank you for the suggestion. I have now added this and also added Is Symmetric/Reflexive/Transitive BinaryRelation based on your comment above.
I've pushed these changes to this branch (as well as fixing a missing ;).
grouptheoryenthusiast
force-pushed
the
fix/master/relations_documentation
branch
from
4fd84cc
to
77a99ff
Compare
fingolfin
added
topic: documentation
fingolfin
added
the
release notes: to be added
fingolfin
added
release notes: added
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Responding to issue #1705 I have added some examples into the relations chapter.
In particular, have added examples into the gapdoc sections within
relation.gd.