Underlines instead of headings in notebook version of docstring for R functions

[sagetrac-aginiewicz]

Things are different in notebook and console:

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

Component: interfaces

Issue created by migration from https://trac.sagemath.org/ticket/4057

[sagetrac-aginiewicz]

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

[sagetrac-mabshoff]

comment:1

Attachment: underline_trick.patch.gz

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

[sagetrac-aginiewicz]

comment:3

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

[sagetrac-aginiewicz]

comment:4

(forgot to assign ticket to myself)

[TimothyClemans]

comment:5

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

[sagetrac-aginiewicz]

better solution to problem

[sagetrac-aginiewicz]

comment:6

Attachment: underline_trick.2.patch.gz

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

[williamstein]

apply this and the patch right above this.

[williamstein]

comment:7

Attachment: sage-4057-part2.patch.gz

REFEREE REPORT:

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

[sagetrac-mabshoff]

comment:8

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

[sagetrac-aginiewicz]

comment:9

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.