Ticket #13009 (closed enhancement: fixed)

Opened 12 months ago

Last modified 11 months ago

Add blank lines for a couple plots in reference manual

Reported by: kcrisman Owned by: jason, was
Priority: trivial Milestone: sage-5.1
Component: graphics Keywords: beginner, sd40.5
Cc: Work issues:
Report Upstream: N/A Reviewers: Karl-Dieter Crisman
Authors: Dan Drake Merged in: sage-5.1.beta4
Dependencies: Stopgaps:

Description

In graphics.py, we have

plot(sin(pi*x), (x, -8, 8)) # Labels not so helpful
plot(sin(pi*x), (x, -8, 8), ticks=2) # Multiples of 2
plot(sin(pi*x), (x, -8, 8), ticks=[[-7,-3,0,3,7],[-1/2,0,1/2]]) # Your choices
plot(sin(pi*x), (x, -8, 8), ticks=[[],[]]) # No ticks at all!

but then in the live documentation only the last one shows up, so we should separate them with

::

things.

Attachments

13009.patch Download (1.3 KB) - added by ddrake 12 months ago.

Change History

comment:1 Changed 12 months ago by kini

Oh, is that why there are so many extra :: in Sage docstrings? I wondered about that.

Why not just wrap them with show() or put them in a single "line" by wrapping them with parentheses and semicolons?

show(plot(sin(pi*x), (x, -8, 8))) # Labels not so helpful
show(plot(sin(pi*x), (x, -8, 8), ticks=2)) # Multiples of 2
show(plot(sin(pi*x), (x, -8, 8), ticks=[[-7,-3,0,3,7],[-1/2,0,1/2]])) # Your choices
show(plot(sin(pi*x), (x, -8, 8), ticks=[[],[]])) # No ticks at all!

or

( plot(sin(pi*x), (x, -8, 8)) ; # Labels not so helpful
  plot(sin(pi*x), (x, -8, 8), ticks=2) ; # Multiples of 2
  plot(sin(pi*x), (x, -8, 8), ticks=[[-7,-3,0,3,7],[-1/2,0,1/2]]) ; # Your choices
  plot(sin(pi*x), (x, -8, 8), ticks=[[],[]]) ) # No ticks at all!

comment:2 Changed 12 months ago by kcrisman

Well, whatever. We've basically been doing it this way for a while, and since plot(foo) does indeed implicitly call show, it's a little easier. There are some doctests out there that use the show() syntax. But I do prefer the :: business.

Changed 12 months ago by ddrake

comment:3 Changed 12 months ago by ddrake

  • Status changed from new to needs_review
  • Authors set to Dan Drake

comment:4 Changed 12 months ago by kcrisman

  • Status changed from needs_review to positive_review
  • Reviewers set to Karl-Dieter Crisman

I don't see a problem with this. Positive review, thanks.

comment:5 Changed 11 months ago by jdemeyer

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