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

Some GAP docstrings are missing? #316

Closed
kalmarek opened this issue Jan 18, 2020 · 6 comments · Fixed by #318 or #364
Closed

Some GAP docstrings are missing? #316

kalmarek opened this issue Jan 18, 2020 · 6 comments · Fixed by #318 or #364

Comments

@kalmarek
Copy link

help?> GAP.Globals.ListPerm
Automata (not loaded):
  2.5-7 ListPermutedAutomata
  
  ‣ ListPermutedAutomata( aut ) ────────────────────────────────────────────────── function
  
  Given an automaton aut, returns a list of automata with permuted states
  
  ───────────────────────────────────────  Example  ───────────────────────────────────────
    gap> x:=Automaton("det",3,2,[ [ 0, 2, 3 ], [ 1, 2, 3 ] ],[ 1 ],[ 2, 3 ]);;
    gap> ListPermutedAutomata(x);
    [ < deterministic automaton on 2 letters with 3 states >, 
      < deterministic automaton on 2 letters with 3 states >, 
      < deterministic automaton on 2 letters with 3 states >, 
      < deterministic automaton on 2 letters with 3 states >, 
      < deterministic automaton on 2 letters with 3 states >, 
      < deterministic automaton on 2 letters with 3 states > ]
  ─────────────────────────────────────────────────────────────────────────────────────────
  

─────────────────────────────────────────────────────────────────────────────────────────────

misses the Reference docstring;

on the other hand

help?> GAP.Globals.PermList
Error, no method found! For debugging hints type ?Recovery from NoMethodFound
Error, no 2nd choice method found for `+' on 2 arguments
ERROR: Error thrown by GAP
Stacktrace:
 [1] error(::String) at ./error.jl:33
 [2] error_handler() at /home/kalmar/.julia/dev/GAP/src/GAP.jl:48
 [3] #call_gap_func#5(::Base.Iterators.Pairs{Union{},Union{},Tuple{},NamedTuple{(),Tuple{}}}, ::typeof(GAP.call_gap_func), ::Main.ForeignGAP.MPtr, ::Main.ForeignGAP.MPtr, ::Vararg{Any,N} where N) at /home/kalmar/.julia/dev/GAP/src/ccalls.jl:149
 [4] call_gap_func(::Main.ForeignGAP.MPtr, ::Main.ForeignGAP.MPtr, ::Vararg{Any,N} where N) at /home/kalmar/.julia/dev/GAP/src/ccalls.jl:139
 [5] #_#5(::Base.Iterators.Pairs{Union{},Union{},Tuple{},NamedTuple{(),Tuple{}}}, ::Main.ForeignGAP.MPtr, ::Main.ForeignGAP.MPtr, ::Vararg{Any,N} where N) at /home/kalmar/.julia/dev/GAP/src/GAP.jl:124
 [6] (::Main.ForeignGAP.MPtr)(::Main.ForeignGAP.MPtr, ::Vararg{Any,N} where N) at /home/kalmar/.julia/dev/GAP/src/GAP.jl:124
 [7] GAP_help_string(::String, ::Bool) at /home/kalmar/.julia/dev/GAP/src/help.jl:4 (repeats 2 times)
 [8] doc(::GAP.GAPHelpType, ::Type) at /home/kalmar/.julia/dev/GAP/src/help.jl:21 (repeats 2 times)
 [9] top-level scope at /buildworker/worker/package_linux64/build/usr/share/julia/stdlib/v1.3/REPL/src/docview.jl:355

(I have to admit GAP docstrings are pretty cool ;-)

@fingolfin
Copy link
Member

@ThomasBreuer I think this is your code, could you have a look?

@ThomasBreuer
Copy link
Member

@kalmarek Thanks for this.
I was able to reproduce the error with ?GAP.Globals.PermList, see #318.
But when I enter ?GAP.Globals.ListPerm, I see two entries, first the one from Reference and then the one from Automata.
Does the access to Reference work at all for you?
(For example, ?GAP.Globals.IsSimpleGroup should find exactly one entry, which belongs to Reference.)

@kalmarek
Copy link
Author

help?> GAP.Globals.IsSimpleGroup
Help: 'IsSimpleGroup' is currently undocumented.
      For details, try ?Undocumented Variables

This is vanilla GAP.jl from master, build with all packages via ] build GAP;

@kalmarek
Copy link
Author

just confirmed on an another machine (clean julia install) with the same results

@ThomasBreuer
Copy link
Member

@kalmarek If I understand the installation from deps/build.jl right then there is no instruction yet to build the GAP Reference Manual, see #320.
(The GAP packages are fetched from an archive, which contains also the documentation of the packages. Thus Julia can access their documentation.)

@fingolfin
Copy link
Member

fingolfin commented Jan 21, 2020

Actually I was a bit hasty, #318 was not enough, we also need #320 (resp. #321)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants