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

Predefined tests for families should be properly documented #3367

Open
JHahnHRO opened this issue Mar 21, 2019 · 1 comment
Open

Predefined tests for families should be properly documented #3367

JHahnHRO opened this issue Mar 21, 2019 · 1 comment
Labels
gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation

Comments

@JHahnHRO
Copy link

In GAP's method selection it is possible to define a necessary relationship between the families of the arguments, for example "The 1st argument of my method is a collection and the 2nd argument's family is the family of elements of said collection"
A number of such standard tests are actually predefined in GAP, e.g. the one above, but they do not seem to be documented anywhere except in the brains of certain experts (like @fingolfin who showed me these).

@JHahnHRO JHahnHRO added kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation labels Mar 21, 2019
@wilfwilson wilfwilson added the gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring label Mar 21, 2019
@fingolfin
Copy link
Member

This is primarily about the family predicates in lib/fampred.g, although there are a few more.

I also noticed that those functions are all world writeable, too -- so perhaps the first thing to do would be to change their definitions to use BindGlobal (resp. BIND_GLOBAL if this file is loaded before the definition of BindGlobal).

Finally, I think that the documentation for what family predicates are doing is rather lacking -- in particular, it is missing examples. Grepping for family predicate doesn't reveal many hits. I think there should be an index entry for family predicate, pointing to paragraph somewhere (possibly in/after/near the InstallMethod documentation) explaining what a family predicate does, and also with at least one example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gapdays2019-spring Issues and PRs that arose at https://www.gapdays.de/gapdays2019-spring kind: enhancement Label for issues suggesting enhancements; and for pull requests implementing enhancements topic: documentation Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

3 participants