On Mon, Dec 17, 2018 at 5:16 PM Dima Pasechnik <dimp...@gmail.com> wrote:
>
> On Mon, Dec 17, 2018 at 4:07 PM E. Madison Bray <erik.m.b...@gmail.com> wrote:
> >
> > On Fri, Dec 14, 2018 at 2:33 PM Volker Braun <vbraun.n...@gmail.com> wrote:
> > >
> > > Afair the all_documented_functions is documenting the starting point of 
> > > our list of hardcoded tab-completions. At one point I went through it by 
> > > hand and tweaked it, though. The module cannot be default imported for 
> > > the reasons you mention. But I think its useful to have the code around 
> > > since it is far from obvious what GAP symbols are useful entry points 
> > > that should be accessible from Sage. GAP only has a single flat namespace 
> > > and its littered with private stuff...
> >
> > It's a fair point that that code *might* be useful for occasionally
> > hard-coding a list of useful GAP symbols.  But in that case it would
> > be code that is not run by importing a module, but rather a function
> > that is used to generate a list of functions, sort of like (I think)
> > we do for PARI (but we would just use it at runtime).
> >
> > However, even if used like that, the present code that lists
> > "documented functions" returns some 10000 functions, a great deal more
> > than the ~1400 we have hard-coded in sage.libs.gap.gap_functions.
> >
> > It should also be used in such a way that it can be kept up-to-date
> > regularly.  As I mentioned elsewhere in this thread, I found that the
> > existing list was quite outdated and contained some entries that
> > weren't even functions (such that trying to libgap.__getattr__ them
> > raised an exception).
> >
> > So unless someone has a concrete plan for dynamically generating a
> > "standard" GAP API, the current code still isn't worth keeping around,
> > at least in its current state.
>
> I suppose we at least should rename these files, prefixing them with
> `_`, to  make
> clear it's not something to be used without much thought.

I think instead I will mark them deprecated, since it's not something
that is currently useful even given some thought.  I'll work more
later with the GAP developers to see what they think about providing a
default list of "common" functions and how would be the best way to go
about that.  Alex seemed skeptical about just using IsDocumentedWord
as-is.

I might just borrow the relevant code from the GAP Jupyter kernel for
tab-completion...

-- 
You received this message because you are subscribed to the Google Groups 
"sage-devel" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to sage-devel+unsubscr...@googlegroups.com.
To post to this group, send email to sage-devel@googlegroups.com.
Visit this group at https://groups.google.com/group/sage-devel.
For more options, visit https://groups.google.com/d/optout.

Reply via email to