Ticket #6270 (closed enhancement: fixed)

Opened 4 years ago

Last modified 4 years ago

[with patch, positive review] add some files from the plot directory to the reference manual

Reported by: jhpalmieri Owned by: jhpalmieri
Priority: minor Milestone: sage-4.0.2
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: Reviewers: Minh Van Nguyen
Authors: John Palmieri Merged in: 4.0.2.alpha0
Dependencies: Stopgaps:

Description

This adds the 8 files to the reference manual (since kcrisman has put so much work into getting them to 100% coverage). It also adds a few cross-references to plot.py and makes one or two small changes (e.g., it removes a reference to rgbcolor at the beginning of plot.py, since that function isn't in the global name space, and its mention suggested that it might be).

Attachments

trac_6270.patch Download (6.3 KB) - added by jhpalmieri 4 years ago.

Change History

Changed 4 years ago by jhpalmieri

comment:1 Changed 4 years ago by mvngu

  • Summary changed from [with patch, needs review] add some files from the plot directory to the reference manual to [with patch, needs work] add some files from the plot directory to the reference manual

When applying the patch, I got the following hunk failures:

----------------------------------------------------------------------
| Sage Version 4.0.1, Release Date: 2009-06-06                       |
| Type notebook() for the GUI, and license() for information.        |
----------------------------------------------------------------------
Loading Sage library. Current Mercurial branch is: 6270
sage: hg_sage.apply("../patch/6270/trac_6270.patch")
cd "/scratch/mvngu/sage-4.0.1/devel/sage" && hg status
cd "/scratch/mvngu/sage-4.0.1/devel/sage" && hg status
cd "/scratch/mvngu/sage-4.0.1/devel/sage" && hg import   "/scratch/mvngu/patch/6270/trac_6270.patch"
applying /scratch/mvngu/patch/6270/trac_6270.patch
patching file sage/plot/plot.py
Hunk #1 FAILED at 6
Hunk #2 FAILED at 1865
2 out of 2 hunks FAILED -- saving rejects to file sage/plot/plot.py.rej
abort: patch failed to apply

The patch was applied on a fresh clone of Sage 4.0.1. Should there be a rebase?

comment:2 Changed 4 years ago by jhpalmieri

I'm sorry -- I forgot to say that this patch depends on #6257. Please apply that one first and try again.

comment:3 Changed 4 years ago by jhpalmieri

  • Summary changed from [with patch, needs work] add some files from the plot directory to the reference manual to [with patch, needs review] add some files from the plot directory to the reference manual

comment:4 Changed 4 years ago by kcrisman

You might want to look at # 6269 as well regarding the rgbcolor thing; I have potentially moved that and hue to a new file.

comment:5 Changed 4 years ago by mvngu

  • Reviewers set to Minh Van Nguyen
  • Summary changed from [with patch, needs review] add some files from the plot directory to the reference manual to [with patch, positive review] add some files from the plot directory to the reference manual

After applying the patch, the following modules are in the reference manual, but the ReST formatting need some polishing:

sage/plot/circle
sage/plot/disk

The following are referred to in the reference manual, but are not yet in the manual. So there's no hyperlink to any of them even if one is defined.

line()
implicit_plot()
region_plot()
scatter_plot()
bar_chart()
contour_plot()
density_plot()
plot_vector_field()
plot_slope_field()
matrix_plot()
complex_plot()

I can give the patch a positive review for adding files under the sage/plot directory to the reference manual. The formatting and referencing issues I mentioned above are not introduced by the patch, and should be addressed in another ticket. So patches should be applied in the following order:

  1. apply the patch at #6257
  2. then apply the patch on this ticket.

comment:6 Changed 4 years ago by mvngu

See #6274 for a follow-up to this ticket.

comment:7 Changed 4 years ago by ncalexan

  • Status changed from new to closed
  • Resolution set to fixed
  • Merged in set to 4.0.2.alpha0
Note: See TracTickets for help on using tickets.