Compromise on the README until resolution of AutoDoc issues
This commit is contained in:
parent
6f367fc14c
commit
d0303b88a6
37
README.md
37
README.md
@ -32,20 +32,29 @@ Perhaps the following GAP interactive session, which constructs the
|
||||
conjugation quandle of the symmetric group on three elements and then performs
|
||||
a few simple computations on that quandle, will give the flavor of RAQ. (It is
|
||||
presumed that the RAQ package has already been loaded with
|
||||
`LoadPackage("RAQ");` prior to these example commands being executed.)
|
||||
|
||||
<!--@BeginExampleSession --><pre>
|
||||
gap> S3 := SymmetricGroup(3);
|
||||
Sym( [ 1 .. 3 ] )
|
||||
gap> Elements(S3);
|
||||
[ (), (2,3), (1,2), (1,2,3), (1,3,2), (1,3) ]
|
||||
gap> Q3 := ConjugationQuandle(S3);
|
||||
<left quandle with 6 generators>
|
||||
gap> elt := Elements(Q3); # the element ^p: below means conjugation by p in S3
|
||||
[ ^():, ^(2,3):, ^(1,2):, ^(1,2,3):, ^(1,3,2):, ^(1,3): ]
|
||||
gap> elt[4]*elt[3]; # So this will produce (1,2,3)^{-1}(1,2)(1,2,3)
|
||||
^(2,3):
|
||||
</pre><!--@EndExampleSession -->
|
||||
`LoadPackage("RAQ");` prior to these example commands being executed.
|
||||
<!--@EndAutoDocPlainText
|
||||
#! @DONT_SCAN_NEXT_LINE -->
|
||||
Also, please excuse/ignore the `#!` at the beginning of each line in the
|
||||
example session, they're there just because this file is also used as part of
|
||||
the RAQ manual produced via AutoDoc.)
|
||||
<!--We have to close the AutoDoc parenthetical, too:
|
||||
#!)
|
||||
#!@BeginExampleSession -->
|
||||
'''
|
||||
#! gap> S3 := SymmetricGroup(3);
|
||||
#! Sym( [ 1 .. 3 ] )
|
||||
#! gap> Elements(S3);
|
||||
#! [ (), (2,3), (1,2), (1,2,3), (1,3,2), (1,3) ]
|
||||
#! gap> Q3 := ConjugationQuandle(S3);
|
||||
#! <left quandle with 6 generators>
|
||||
#! gap> elt := Elements(Q3); # the element ^p: below means conjugation by p in S3
|
||||
#! [ ^():, ^(2,3):, ^(1,2):, ^(1,2,3):, ^(1,3,2):, ^(1,3): ]
|
||||
#! gap> elt[4]*elt[3]; # So this will produce (1,2,3)^{-1}(1,2)(1,2,3)
|
||||
#! ^(2,3):
|
||||
'''
|
||||
<!--@EndExampleSession
|
||||
@AutoDocPlainText -->
|
||||
|
||||
Note in particular that RAQ generally, unless otherwise specifically
|
||||
requested, produces __left__ quandles and racks. (That is to say, quandles in
|
||||
|
Loading…
Reference in New Issue
Block a user