Opened 9 years ago

Last modified 2 years ago

#10032 new defect

Even more improvements in plot documentation

Reported by: kcrisman Owned by: jason, was
Priority: minor Milestone: sage-6.4
Component: graphics Keywords: beginner
Cc: jason, kcrisman, mpatel, boothby Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description (last modified by chapoton)

This is a followup to #9746, to make the docs even better. In addition to the things below, we should put in references like there will now be in matrix_plot (see #9740) to the actual function in the documentation.


In scatterplot, there is another one of those 'these are equivalent' things, but they're not separated out. Also, I get code{scatter_plot.options} instead of the actual code. Should it be show() or show()?

In sage.plot.polygon.polygon we have something similar in the examples - somehow you only got some of them. Again with the extra options guy, too. Also, "Extra options will get passed on to show()" should have a hyperlink.

Same with the equivalent in point.py, in both point and points.

In the plot_field.py file, why did you once add the x,y variable declaration and once not? It doesn't really matter to me, but I wonder if there is something I'm missing. Again with the show() or show(), and the equivalent. It's not so important to me with the equivalent showing two things, but I feel like maybe you changed that one place - or maybe not.

In plot.py, ironically, just above the place where you fixed the 1.5/(1+e(-x)) thing, there are a bunch of plots I didn't separate in my custom ticks patch. My apologies - but there they are! I also still get an error 'ellipsis object not callable' or something in 'add grid lines at specific positions (using lists/tuples)'. There's an ellipsis that got stuck in there still somehow - I think you got a different one of these.

In line.py, after the cool cat there are a couple things as in the previous files - one nonseparated, one equivalent issue/show() issue.

In disk.py, maybe the disk that is parallel to the xy-plane should be plotted, not just its type? Same equiv/show question.

I don't know what happened in density plot, but I think a tick is missing in the DensityPlot? documentation - likely my fault? This is in 'Examples'.

In contour plot, the very last example under region_plot should have two plots, but has one. But they are different.

The circles also has the parallel to the xy-plane issue when it comes to giving the type, but not the plot.

Change History (13)

comment:1 follow-up: Changed 9 years ago by jason

Another big improvement would be making all of the plot files start with the user commands, rather than the behind-the-scenes objects.

comment:2 in reply to: ↑ 1 Changed 9 years ago by kcrisman

Replying to jason:

Another big improvement would be making all of the plot files start with the user commands, rather than the behind-the-scenes objects.

I don't think this matters at all unless the way our documentation is generated changes, since it's just done alphabetically, right? Or am I missing something?

comment:3 follow-up: Changed 9 years ago by jason

Oh, right.  Well, then we should edit the RST files to make it not do alphabetical order, but do the order in the files (I believe it is just an option we can specify somewhere).  Anyway, the point is that it is really confusing right now since the first half of the documentation has no relevance to the end user.

comment:4 in reply to: ↑ 3 Changed 9 years ago by kcrisman

Replying to jason:

Oh, right.  Well, then we should edit the RST files to make it not do alphabetical order, but do the order in the files (I believe it is just an option we can specify somewhere).  Anyway, the point is that it is really confusing right now since the first half of the documentation has no relevance to the end user.

Which however would be another ticket, since this would affect lots of things. I think that in general this would be a good change for lots of files - though a big job for someone hand-editing like me.

comment:5 Changed 9 years ago by jason

Well, I meant a switch just for these files, not a system-wide switch.

comment:6 Changed 7 years ago by kcrisman

  • Description modified (diff)
  • Keywords beginner added

comment:7 Changed 6 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:8 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:9 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:10 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4

comment:11 Changed 5 years ago by chapoton

  • Description modified (diff)

comment:12 follow-up: Changed 2 years ago by souravsingh

I am interested in working on this. How do I start?

comment:13 in reply to: ↑ 12 Changed 2 years ago by kcrisman

I am interested in working on this. How do I start?

Welcome to Sage! Try looking at the developer guide for information. In this case, since it is mainly asking for documentation upgrades, you could create a new branch for this ticket, try fixing the various things indicated, and then once you've checked it builds and looks correct (see e.g. here) then you can post that branch after you commit it. Unfortunately using git is a bit of a learning curve, but luckily most of the work will be just in editing the files and then building documentation to make sure it looks nice.

By the way, this ticket is fairly old, so you may want to check whether everything listed is still a problem. Good luck!

Note: See TracTickets for help on using tickets.