Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Randomize is declared and implemented in the GAP library, but documentation is in orb package #2018

Closed
fingolfin opened this issue Dec 11, 2017 · 1 comment · Fixed by #3619
Labels
good first issue Issues that can be understood and addressed by newcomers to GAP development kind: bug Issues describing general bugs, and PRs fixing them topic: documentation Issues and PRs related to documentation

Comments

@fingolfin
Copy link
Member

I suspect Randomize used to be in the orb package but then was migrated to the GAP library -- except the documentation was not moved.

So most likely the fix is to move the documentation, too.

@fingolfin fingolfin added kind: bug Issues describing general bugs, and PRs fixing them topic: documentation Issues and PRs related to documentation labels Dec 11, 2017
@fingolfin
Copy link
Member Author

Also, the order of arguments is "wrong": we tried to have the random source be first argument for as many things as possible, but here it is the second (final) argument. However, I think we could easily fix this by changing the documentation and implementation to reverse this (implemented using InstallMethodWithRandomSource), and then providing a single InstallOtherMethod with the old order, which redispatches to the new order (and prints an InfoObsolete warning).

@fingolfin fingolfin added the good first issue Issues that can be understood and addressed by newcomers to GAP development label Feb 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issues that can be understood and addressed by newcomers to GAP development kind: bug Issues describing general bugs, and PRs fixing them topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant