Opened 13 years ago

Closed 8 years ago

#3007 closed enhancement (worksforme)

gap.Factorization? is useless

Reported by: was Owned by: was
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: interfaces Keywords:
Cc: Merged in:
Authors: Reviewers: Travis Scrimshaw
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

See this thread. The solution suggested by Steve Linton below does *not* work exactly as suggested.


Forwarded conversation
Subject: [sage-support] Documentation with several entries
------------------------

From: Hector Villafuerte <hectorvd@gmail.com>
Date: Tue, Apr 22, 2008 at 5:12 PM
To: sage-support@googlegroups.com



Hi,
while trying this:
sage: gap.Factorization?

I got this...

Type:        <class 'sage.interfaces.gap.GapFunction'>
Definition:  gap.Factorization( [noargspec] )
Docstring:
Help: several entries match this topic - type ?2 to get match [2]

[1] Reference: factorization
[2] Reference: Factorization


Which I can't get to work in either the Notebook or the command line. Any ideas?
Thanks!
--
 Hector

--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-support@googlegroups.com
To unsubscribe from this group, send email to sage-support-unsubscribe@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-support
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---

----------
From: William Stein <wstein@gmail.com>
Date: Wed, Apr 23, 2008 at 7:42 AM
To: Steve Linton <sal@cs.st-and.ac.uk>


Any thoughts about how to disambiguate this sort of thing in the context
of Sage?  Of course, you can just plead that you work on the gap interface
almost 2.5 years ago and remember nothing :-)
--
William Stein
Associate Professor of Mathematics
University of Washington
http://wstein.org
----------
From: Steve Linton <sal@cs.st-and.ac.uk>
Date: Wed, Apr 23, 2008 at 8:34 AM
To: William Stein <wstein@gmail.com>


gap.2? might just work.

You simply need to send GAP ?2 or HELP("2");

The message is being generated from HELP_SHOW_MATCHES in lib/helpbase.gi (line
713). I dare say we could move that message to a global variable so that you
could change it to  "type gap.2? ...." in a future release.

       Steve
--
Steve Linton    School of Computer Science  &
     Centre for Interdisciplinary Research in Computational Algebra
            University of St Andrews    Tel   +44 (1334) 463269
http://www.cs.st-and.ac.uk/~sal          Fax   +44 (1334) 463278
The University is a charity registered in Scotland : No SC013532



-- 
William Stein
Associate Professor of Mathematics
University of Washington
http://wstein.org 

Change History (5)

comment:1 Changed 12 years ago by AlexGhitza

  • Type changed from defect to enhancement

comment:2 Changed 9 years ago by iandrus

  • Report Upstream set to N/A

The following works except that it's not properly offset, i.e. you have to hit space a few times before you find the documentation for Factorization.

sage: gap.Factorization?
Type:		GapFunction
Base Class:	<class 'sage.interfaces.gap.GapFunction'>
String Form:	Factorization
Namespace:	Interactive
Loaded File:	/Users/gvol/SageStuff/sage-5.0.rc0/local/lib/python2.7/site-packages/sage/interfaces/gap.py
Source File:	/Users/gvol/SageStuff/sage-5.0.rc0/devel/sage/sage/interfaces/gap.py
Definition:	gap.Factorization(self, *args, **kwds)
Docstring:
    Help: several entries match this topic - type ?2 to get match [2]
    
    [1] Reference: factorization
    [2] Reference: Factorization

Call def:	gap.Factorization(self, *args, **kwds)

Call docstring:
    x.__init__(...) initializes x; see help(type(x)) for signature


sage: gap."2"?
...the real documentation...

comment:3 Changed 8 years ago by iandrus

  • Milestone changed from sage-5.8 to sage-duplicate/invalid/wontfix
  • Status changed from new to needs_review

This has been fixed in 5.7.

comment:4 Changed 8 years ago by tscrim

  • Reviewers set to Travis Scrimshaw
  • Status changed from needs_review to positive_review

comment:5 Changed 8 years ago by jdemeyer

  • Resolution set to worksforme
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.