Opened 4 months ago

Closed 3 months ago

#33400 closed enhancement (fixed)

Add pictures to various 3d graphics manual pages

Reported by: jhonrubia6 Owned by:
Priority: minor Milestone: sage-9.6
Component: documentation Keywords: documentation
Cc: slelievre, egourgoulhon Merged in:
Authors: Javier Honrubia González Reviewers: Eric Gourgoulhon
Report Upstream: N/A Work issues:
Branch: 649a510 (Commits, GitHub, GitLab) Commit: 649a5109878540bc1442789fcdf7a50bb285829e
Dependencies: Stopgaps:

Status badges

Description (last modified by jhonrubia6)

Add pictures to illustrate the document examples in the following files:

  • sage/src/sage/plot/plot3d/plot_field3d.py
  • sage/src/sage/plot/plot3d/list_plot3d.py
  • sage/src/sage/plot/plot3d/shapes2.py
  • sage/src/sage/plot/plot3d/parametric_surface.pyx

Change History (17)

comment:1 Changed 4 months ago by slelievre

  • Cc slelievre added
  • Description modified (diff)

comment:2 Changed 4 months ago by egourgoulhon

  • Cc egourgoulhon added

comment:3 Changed 4 months ago by jhonrubia6

  • Description modified (diff)

comment:4 Changed 4 months ago by jhonrubia6

  • Branch set to u/jhonrubia6/add_pictures_to_various_3d_graphics_manual_pages

comment:5 Changed 4 months ago by jhonrubia6

  • Commit set to ad1938809ab1979b7afeecd32fece10fa4ce25f9
  • Status changed from new to needs_review

New commits:

​ad19388Pictures added.

comment:6 Changed 4 months ago by egourgoulhon

  • Status changed from needs_review to needs_work

Thanks for implementing this!

As revealed by the patchbot: 

sage -t --long --random-seed=112004569360728722888029267037076072284 src/sage/plot/plot3d/shapes2.py  # 1 doctest failed
sage -t --long --random-seed=112004569360728722888029267037076072284 src/sage/plot/plot3d/parametric_surface.pyx  # 1 doctest failed

comment:7 Changed 4 months ago by git

  • Commit changed from ad1938809ab1979b7afeecd32fece10fa4ce25f9 to b1d7602d7e90408c46ed26ace286022b6f1d2f26

Branch pushed to git repo; I updated commit sha1. New commits:

​b1d7602Changes made to pass the test

comment:8 Changed 4 months ago by jhonrubia6

  • Status changed from needs_work to needs_review

comment:9 Changed 4 months ago by egourgoulhon

  • Reviewers set to Eric Gourgoulhon
  • Status changed from needs_review to positive_review

Looks nice! Thank you very much.

comment:10 Changed 4 months ago by egourgoulhon

Just noticed something in parametric_surface.pyx:

  • the first .. PLOT:: is ill-placed: it should be located immediately after show(P)
  • the second .. PLOT:: is immediately followed by ./, which looks like a typo; indeed this .. PLOT:: directive is not effective: no image of the Moebius strip is generated in the doc.

comment:11 Changed 4 months ago by egourgoulhon

  • Status changed from positive_review to needs_work

comment:12 Changed 4 months ago by git

  • Commit changed from b1d7602d7e90408c46ed26ace286022b6f1d2f26 to 649a5109878540bc1442789fcdf7a50bb285829e

Branch pushed to git repo; I updated commit sha1. New commits:

​649a510Typos fixed.

comment:13 Changed 4 months ago by jhonrubia6

  • Status changed from needs_work to needs_review

comment:14 follow-up: Changed 4 months ago by egourgoulhon

  • Status changed from needs_review to positive_review

Thanks for the correction and for your work on this!

Note that 3d plots in the html documentation will be soon based on threejs and no longer on jmol, see #33507.

comment:15 in reply to: ↑ 14 ; follow-up: Changed 3 months ago by jhonrubia6

Replying to egourgoulhon:

Note that 3d plots in the html documentation will be soon based on threejs and no longer on jmol, see #33507.

I'm sorry. I do not understand the implications on this. Will I need to use other directive than .. PLOT?

comment:16 in reply to: ↑ 15 Changed 3 months ago by egourgoulhon

Replying to jhonrubia6:

Replying to egourgoulhon:

Note that 3d plots in the html documentation will be soon based on threejs and no longer on jmol, see #33507.

I'm sorry. I do not understand the implications on this. Will I need to use other directive than .. PLOT?

For the moment, the .. PLOT sections are still there and generate static jmol images; there are simply new sections .. ONLY:: html, which generate threejs plots on demand, see ​https://git.sagemath.org/sage.git/tree/src/sage/plot/plot3d/plot3d.py?id=72c8378de1f5ab1de0d1062610a0d5d947415746

comment:17 Changed 3 months ago by vbraun

  • Branch changed from u/jhonrubia6/add_pictures_to_various_3d_graphics_manual_pages to 649a5109878540bc1442789fcdf7a50bb285829e
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.