Ticket #8153 (closed enhancement: wontfix)
typo in documentation
| Reported by: | zimmerma | Owned by: | mvngu |
|---|---|---|---|
| Priority: | trivial | Milestone: | sage-duplicate/invalid/wontfix |
| Component: | documentation | Keywords: | |
| Cc: | Work issues: | ||
| Report Upstream: | N/A | Reviewers: | |
| Authors: | Merged in: | ||
| Dependencies: | Stopgaps: |
Description
trivial patch
Attachments
-
13535.patch
(707 bytes) -
added by zimmerma 3 years ago.
-
before.png
(101.7 KB) -
added by mvngu 3 years ago.
- before applying 13535.patch
-
after.png
(106.6 KB) -
added by mvngu 3 years ago.
- after applying 13535.patch
-
trac_8153-plot-doc.patch
(680 bytes) -
added by mvngu 3 years ago.
- based on Sage 4.3.2.alpha1
-
after2.png
(101.5 KB) -
added by mvngu 3 years ago.
- after applying trac_8153-plot-doc.patch
Change History
comment:2 Changed 3 years ago by zimmerma
- Status changed from new to needs_review
Is this up for review?
yes it should be easy :-)
comment:3 Changed 3 years ago by mvngu
- Summary changed from [with patch] typo in documentation to typo 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 3 years ago by zimmerma
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 3 years ago by jhpalmieri
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".
