Compromise on the README until resolution of AutoDoc issues

This commit is contained in:
Glen Whitney 2018-08-19 10:22:19 -07:00
parent 6f367fc14c
commit d0303b88a6

View File

@ -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 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 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 presumed that the RAQ package has already been loaded with
`LoadPackage("RAQ");` prior to these example commands being executed.) `LoadPackage("RAQ");` prior to these example commands being executed.
<!--@EndAutoDocPlainText
<!--@BeginExampleSession --><pre> #! @DONT_SCAN_NEXT_LINE -->
gap> S3 := SymmetricGroup(3); Also, please excuse/ignore the `#!` at the beginning of each line in the
Sym( [ 1 .. 3 ] ) example session, they're there just because this file is also used as part of
gap> Elements(S3); the RAQ manual produced via AutoDoc.)
[ (), (2,3), (1,2), (1,2,3), (1,3,2), (1,3) ] <!--We have to close the AutoDoc parenthetical, too:
gap> Q3 := ConjugationQuandle(S3); #!)
<left quandle with 6 generators> #!@BeginExampleSession -->
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> S3 := SymmetricGroup(3);
gap> elt[4]*elt[3]; # So this will produce (1,2,3)^{-1}(1,2)(1,2,3) #! Sym( [ 1 .. 3 ] )
^(2,3): #! gap> Elements(S3);
</pre><!--@EndExampleSession --> #! [ (), (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 Note in particular that RAQ generally, unless otherwise specifically
requested, produces __left__ quandles and racks. (That is to say, quandles in requested, produces __left__ quandles and racks. (That is to say, quandles in