From d0303b88a66dac454b2271e2465f8a0669ac6e03 Mon Sep 17 00:00:00 2001 From: Glen Whitney Date: Sun, 19 Aug 2018 10:22:19 -0700 Subject: [PATCH] Compromise on the README until resolution of AutoDoc issues --- README.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index cb4afc8..9f4489f 100644 --- a/README.md +++ b/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.) - -
-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);
-
-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):
-
+`LoadPackage("RAQ");` prior to these example commands being executed. + +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.) + +''' +#! 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); +#! +#! 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): +''' + Note in particular that RAQ generally, unless otherwise specifically requested, produces __left__ quandles and racks. (That is to say, quandles in