Opened 13 years ago

Closed 13 years ago

#8153 closed enhancement (wontfix)

typo in documentation

Reported by: Paul Zimmermann Owned by: Minh Van Nguyen
Priority: trivial Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords:
Cc: Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

trivial patch

Attachments (5)

13535.patch (707 bytes) - added by Paul Zimmermann 13 years ago.
before.png (101.7 KB) - added by Minh Van Nguyen 13 years ago.
before applying 13535.patch
after.png (106.6 KB) - added by Minh Van Nguyen 13 years ago.
after applying 13535.patch
trac_8153-plot-doc.patch (680 bytes) - added by Minh Van Nguyen 13 years ago.
based on Sage 4.3.2.alpha1
after2.png (101.5 KB) - added by Minh Van Nguyen 13 years ago.
after applying trac_8153-plot-doc.patch

Download all attachments as: .zip

Change History (11)

Changed 13 years ago by Paul Zimmermann

Attachment: 13535.patch added

comment:1 Changed 13 years ago by Minh Van Nguyen

Is this up for review?

comment:2 Changed 13 years ago by Paul Zimmermann

Status: newneeds_review

Is this up for review?

yes it should be easy :-)

Changed 13 years ago by Minh Van Nguyen

Attachment: before.png added

before applying 13535.patch

Changed 13 years ago by Minh Van Nguyen

Attachment: after.png added

after applying 13535.patch

Changed 13 years ago by Minh Van Nguyen

Attachment: trac_8153-plot-doc.patch added

based on Sage 4.3.2.alpha1

Changed 13 years ago by Minh Van Nguyen

Attachment: after2.png added

after applying trac_8153-plot-doc.patch

comment:3 Changed 13 years ago by Minh Van Nguyen

Summary: [with patch] typo in documentationtypo in documentation

The attachment 13535.patch actually removes Sphinx formatting of a block of example code. See before.png for the situation before applying 13535.patch. The image after.png shows the situation after applying 13535.patch. Perhaps trac_8153-plot-doc.patch is the effect you originally wanted to achieve? See after2.png for the result of applying trac_8153-plot-doc.patch.

comment:4 Changed 13 years ago by Paul Zimmermann

Perhaps trac_8153-plot-doc.patch is the effect you originally wanted to achieve?

no, since with the tty interface of Sage we still get two ':':

sage: plot?
...
        We plot the sin function::
...

comment:5 Changed 13 years ago by John Palmieri

The double colons are an essential part of the documentation, and they are ubiquitous. mvngu's pictures show what happens when you change them, and it's not good. Meanwhile, see #8161 for a patch which changes all double colons to single ones when displaying docstrings using the command-line interface. That ticket will "fix" the issue raised here.

I think this ticket should be closed as "wontfix".

comment:6 Changed 13 years ago by Minh Van Nguyen

Milestone: sage-4.3.2sage-duplicate/invalid/wontfix
Resolution: wontfix
Status: needs_reviewclosed

Closing this ticket as "wontfix". See #8161 for a follow-up ticket.

Note: See TracTickets for help on using tickets.