Opened 15 years ago

Last modified 2 years ago

#1062 needs_info enhancement

gp interface help should use extended help text (from "??")

Reported by: Carl Witty Owned by: William Stein
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: interfaces Keywords: pari/gp, help
Cc: Vincent Delecroix, Jeroen Demeyer, Samuel Lelièvre Merged in:
Authors: Reviewers: Michael Orlitzky
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

<wstein> 
 The new ?? help looks quite nice. It would
 be good for gp.foo? to use it.

The idea is that

sage: foo = gp(x)
sage: foo.polroots?

should use the help text from the gp command ??polroots.

The obvious approach is to change '?%s' to '??%s' in gp.py's help() method. This doesn't quite work, for two reasons:

1) gphelp carefully formats the text to fit in the current line width, and then Sage displays this text indented; so almost every line wraps.

2) gphelp uses control characters to make words bold, underlined, etc.; when the help is viewed from the notebook, these control codes are visible in the output, and look very ugly.

Change History (5)

comment:1 Changed 7 years ago by Marc Mezzarobba

Report Upstream: N/A

See #17860 for a possible strategy.

comment:2 Changed 4 years ago by Samuel Lelièvre

Cc: Vincent Delecroix Jeroen Demeyer Samuel Lelièvre added
Keywords: pari/gp help added

comment:3 Changed 3 years ago by Vincent Delecroix

Milestone: sage-wishlistsage-duplicate/invalid/wontfix
Status: newneeds_review

This works in cypari2 which is de facto the way to use PARI in Sage

sage: x.polroots?
Signature:      x.polroots(precision)
Docstring:     
   Complex roots of the given polynomial using Schonhage's method, as
   modified by Gourdon.

comment:4 Changed 3 years ago by Michael Orlitzky

Reviewers: Michael Orlitzky
Status: needs_reviewpositive_review

comment:5 Changed 2 years ago by Frédéric Chapoton

Status: positive_reviewneeds_info

I do not agree that this works. We currently display only the short documentation, for pari() objects as well as for gp() objects.

The complete doc is much longer.

Note: See TracTickets for help on using tickets.