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

Deprecate undocumented extra arguments for DeclareGlobalFunction and InstallGlobalFunction #3694

Merged
merged 1 commit into from
Oct 9, 2019

Commits on Oct 7, 2019

  1. Deprecate extra args for {Declare,Install}GlobalFunction

    The extra argument was never documented for `InstallGlobalFunction`. In
    contrast, for `DeclareGlobalFunction`, the documentation for a long time
    claimed that it required exactly (!) two arguments, although all
    examples only showed one argument, and the documentation never said what
    the other argument was supposed to do. Various people then made
    differing guesses as to the supposed meaning of the extra arguments:
    some put in an info string; some put in a list of input filters; some
    just a single filter. This PR removes several of these from the GAP
    library itself.
    
    Various packages still use these extra arguments, and loading them will
    trigger the warnings. Some already fixed it in their repositories and
    just need to make releases. When the time comes for releasing GAP 4.12,
    we can see if all packages are adapted, and then depending on that
    either turn the warning into an error; or conversely, increase the
    warning level to 2, to hide it from regular users who might be confused
    by the message.
    fingolfin committed Oct 7, 2019
    Configuration menu
    Copy the full SHA
    748c74b View commit details
    Browse the repository at this point in the history