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.

Sign up for GitHub

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

tell JuliaInterface to load GAPDoc #1009

Merged
merged 1 commit into from
Jun 20, 2024
Merged

tell JuliaInterface to load GAPDoc #1009

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/JuliaInterface/PackageInfo.g
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Dependencies := rec(
GAP := ">= 4.11", # need compatible code in GAP's src/julia_gc.c
NeededOtherPackages := [ ],
SuggestedOtherPackages := [ ],
OtherPackagesLoadedInAdvance := [ [ "GAPDoc", "1.6.6" ] ], # need StripEscapeSequences
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love this, OtherPackagesLoadedInAdvance is obscure and the code using StripEscapeSequences is unclear to me (i.e. why StripEscapeSequences is even needed there is not immediately visible). And to start with, why StripEscapeSequences isn't in the GAP library (which calls it, too! only in the help system, though).

But it's a pragmatic solution for the moment, so let's merge it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point is that we cannot add GAPDoc to the needed packages of JuliaInterface because JuliaInterface is a needed package of GAP, and GAP does not allow us to silently add needed packages of GAP. (In this sense, the fact that using OtherPackagesLoadedInAdvance is possible at all can be regarded as a bug in GAP.)

Concerning the GAPDoc code in question, I agree that it should better be in the GAP library, but I cannot simply change this.

If I remember well then the idea behind needed packages of GAP was (besides the use case GAPDoc) that one could eventually split off more parts of the GAP library into packages.

ExternalConditions := [ ],
),

Expand Down
Loading