Ticket #4057 (closed defect: fixed)

Opened 3 months ago

Last modified 4 days ago

[with patch, positive review] Underlines instead of headings in notebook version of docstring for R functions

Reported by: aginiewicz Assigned to: aginiewicz
Priority: minor Milestone: sage-3.2.1
Component: interfaces Keywords:
Cc:

Description (Last modified by mabshoff)

Things are different in notebook and console:

  • Because of underline trick, in notebook headings in docstring consists of only underline!

Attachments

underline_trick.patch (0.6 kB) - added by aginiewicz on 09/03/2008 08:15:04 PM.
a simple (and probably not best) way to deal with "underline only" problem in notebook docstring for R functions
underline_trick.2.patch (477 bytes) - added by aginiewicz on 09/15/2008 02:10:21 PM.
better solution to problem
sage-4057-part2.patch (1.0 kB) - added by was on 11/27/2008 10:31:32 AM.
apply this and the patch right above this.

Change History

09/03/2008 08:15:04 PM changed by aginiewicz

  • attachment underline_trick.patch added.

a simple (and probably not best) way to deal with "underline only" problem in notebook docstring for R functions

09/03/2008 08:15:50 PM changed by mabshoff

  • status changed from new to closed.
  • resolution set to invalid.
  • milestone changed from sage-3.1.2 to sage-duplicate/invalid.

Hi,

this is some laundry list of things and should be first discussed on sage-devel before opening clearly defined tickets. Trac is not a discussion forum :)

Invalid.

Cheers,

Michael

09/03/2008 08:25:45 PM changed by mabshoff

  • status changed from closed to reopened.
  • resolution deleted.
  • description changed.
  • milestone changed from sage-duplicate/invalid to sage-3.1.2.

09/03/2008 08:34:00 PM changed by aginiewicz

  • type changed from enhancement to defect.
  • summary changed from Possible improvements to ? and ?? for R functions to [with patch, needs review] Underlines instead of headings in notebook version of ?? for R functions.

when limited to one issue, defect seems to fit better to this one...

09/03/2008 09:15:33 PM changed by aginiewicz

  • owner changed from was to aginiewicz.
  • status changed from reopened to new.
  • summary changed from [with patch, needs review] Underlines instead of headings in notebook version of ?? for R functions to [with patch, needs review] Underlines instead of headings in notebook version of docstring for R functions.

(forgot to assign ticket to myself)

09/08/2008 04:45:41 AM changed by TimothyClemans

  • summary changed from [with patch, needs review] Underlines instead of headings in notebook version of docstring for R functions to [with patch, positive review] Underlines instead of headings in notebook version of docstring for R functions.

See http://sage.math.washington.edu/home/tclemans/R_docstring_before_after.png for the before and after screenshots.

09/15/2008 02:10:21 PM changed by aginiewicz

  • attachment underline_trick.2.patch added.

better solution to problem

09/15/2008 02:16:22 PM changed by aginiewicz

  • summary changed from [with patch, positive review] Underlines instead of headings in notebook version of docstring for R functions to [with patch, needs review] Underlines instead of headings in notebook version of docstring for R functions.

I attached better fix of problem, it fixes not only the r.sth? notation but also not fixed by previous - r.help("sth") - also it doesn't add check related to R in generic module so I guess previous was bad

11/27/2008 10:31:32 AM changed by was

  • attachment sage-4057-part2.patch added.

apply this and the patch right above this.

11/27/2008 10:32:09 AM changed by was

  • summary changed from [with patch, needs review] Underlines instead of headings in notebook version of docstring for R functions to [with patch, positive review] Underlines instead of headings in notebook version of docstring for R functions.

REFEREE REPORT:

Looks good, but needs to *only* delete the underline in embedded mode. I've attached a patch to do that.

11/28/2008 01:52:04 PM changed by mabshoff

  • status changed from new to closed.
  • resolution set to fixed.
  • milestone changed from sage-3.2.2 to sage-3.2.1.

Merged underline_trick.2.patch and sage-4057-part2.patch in Sage 3.2.1.rc0.

Andrzej: Your patch was a diff, please make sure to post proper hg patches in the future. I have committed this patch in your name to the repo for proper credit.

Cheers,

Michael

11/28/2008 03:41:01 PM changed by aginiewicz

I know, the patch was attached before the one from which I found out earlier you prefer hg patch :)...

thanks for including this anyway, cheers, Andrzej.