Arguments of FreeBurnsideGroup are switched in the documentation

[BrauerSuzuki]

I'm not sure if this is the right place to report this. Anyhow, the documentation states:
FreeBurnsideGroup( exp, num )

But the function works as
FreeBurnsideGroup( num, exp )

[fingolfin]

This is the right place to report it. @laurentbartholdi needs to decide whether to adjust the documentation to reality (advantage: existing code using this function won't break; and matches the usual argument order for B(m,n)) or the behavior to match the documentation (advantage: ? perhaps similarity to a few other functions which all have <num> as the final argument).

[laurentbartholdi]

Fixed on github. I kept the standard B(m,n) for m generators, exponent n. I haven't created a new release yet... the argument order for Engel groups is "wrong" in the sense that it's more natural and systematic to put the number of generators first. I'm inclined to change the order (possibly breaking existing code) since it's not much used, and certainly not within preexisting code. Any opinions?

…

On Thu, 4 Jul 2024 at 14:15, Max Horn ***@***.***> wrote: This is the right place to report it. @laurentbartholdi <https://github.com/laurentbartholdi> needs to decide whether to adjust the documentation to reality (advantage: existing code using this function won't break; and matches the usual argument order for B(m,n)) or the behavior to match the documentation (advantage: ? perhaps similarity to a few other functions which all have <num> as the final argument). — Reply to this email directly, view it on GitHub <#23 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AARAQUBFCPCWZIO3TUUK25TZKVDIJAVCNFSM6AAAAABHAURBZOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBYHE3DOOBSHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Laurent Bartholdi laurent.bartholdi<at>gmail<dot>com Fachrichtung Informatik+Mathematik, Universität des Saarlandes Postfach 151150, 66041 Saarbrücken, Germany Tel. +49 681 3023227, Sekr. +49 681 3023430

[fingolfin]

Your plan sounds sensible to me.