Opened 10 years ago

Closed 10 years ago

#10650 closed defect (fixed)

documentation bug in the class sage.calculus.riemann.ColorPlot

Reported by: tmonteil Owned by: mvngu
Priority: minor Milestone: sage-4.6.2
Component: documentation Keywords: days28, beginner
Cc: sage-combinat, rlanger, tmonteil Merged in: sage-4.6.2.alpha3
Authors: Robin Langer Reviewers: Gagan Sekhon
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

The documentation of the class sage.calculus.riemann.ColorPlot?

contains an example which is not well interpreted.

They are two leading :: which may be the cause of the problem.

Attachments (1)

trac_10650-example_bug_in_ColorPlot-rl.patch (952 bytes) - added by rlanger 10 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 follow-up: Changed 10 years ago by mvngu

The double colon "::" should immediately follow the section title "EXAMPLES". Thus we should have

class ColorPlot(GraphicPrimitive):
    """                                                                         
    The GraphicsPrimitive to display complex functions in using the domain      
        coloring method                                                         
                                                                                
    INPUT:                                                                      
                                                                                
        - ``z_values`` -- An array of complex values to be plotted.             
                                                                                
        - ``x_range`` -- A minimum and maximum x value for the plot.            
                                                                                
        - ``y_range`` -- A minimum and maximum y value for the plot.            
                                                                                
    EXAMPLES::

        sage: p = complex_plot(lambda z: z^2-1, (-2, 2), (-2, 2))               
    """

comment:2 in reply to: ↑ 1 Changed 10 years ago by rlanger

  • Status changed from new to needs_review

Replying to mvngu:

The double colon "::" should immediately follow the section title "EXAMPLES". Thus we should have

I did it. Ticket is ready for review.

comment:3 Changed 10 years ago by rlanger

  • Authors set to Robin Langer

comment:4 Changed 10 years ago by gagansekhon

  • Reviewers set to Gagan Sekhon
  • Status changed from needs_review to positive_review

comment:5 Changed 10 years ago by jdemeyer

  • Merged in set to sage-4.6.2.alpha3
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.