Opened 5 years ago

Closed 5 years ago

#9655 closed enhancement (fixed)

Add an example plotting spherical harmonics to spherical_plot3d's docstring

Reported by: olazo Owned by: olazo
Priority: minor Milestone: sage-4.6.1
Component: documentation Keywords: spherical, harmonics
Cc: Merged in: sage-4.6.1.alpha1
Authors: Oscar Gerardo Lazo Arjona Reviewers: Simon Spicer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description (last modified by mvngu)

Ploting Spherical Harmonics is one of the most useful ways to use spherical_plot3d. Adding an example of that would be nice.

Apply:

  1. trac-9655_spherical-harmonic-example.patch
  2. trac-9655_reviewer.patch

Attachments (2)

trac-9655_spherical-harmonic-example.patch (1.0 KB) - added by mvngu 5 years ago.
trac-9655_reviewer.patch (1.3 KB) - added by mvngu 5 years ago.

Download all attachments as: .zip

Change History (15)

comment:1 Changed 5 years ago by olazo

  • Status changed from new to needs_review

comment:2 Changed 5 years ago by olazo

  • Priority changed from major to minor

Changed 5 years ago by mvngu

comment:3 follow-up: Changed 5 years ago by mvngu

  • Authors set to Oscar Gerardo Lazo Arjona
  • Description modified (diff)
  • Reviewers set to Minh Van Nguyen

Here are some issues with olazo's patch:

  • The "User" should be filled with your real name and preferred contact email address. I have fixed this in my update of olazo's patch; see trac-9655_spherical-harmonic-example.patch.
  • The code in olazo's patch does not conform to Python coding conventions. In particular, see PEP 8. This is fixed in my reviewer patch; see trac-9655_reviewer.patch. Someone other than me needs to review that. If my patch gets a positive review, the whole ticket gets a positive review.

comment:4 Changed 5 years ago by mvngu

  • Summary changed from Add an example ploting spherical harmonics to spherical_plot3d's docstring to Add an example plotting spherical harmonics to spherical_plot3d's docstring

comment:5 in reply to: ↑ 3 Changed 5 years ago by olazo

Replying to mvngu:

Here are some issues with olazo's patch:

This is the first patch I produced using mecurial queues. At some point I recieved a warning about User not being defined, but how do I set it up? I mean other than directly editing the .patch

  • The code in olazo's patch does not conform to Python coding conventions. In particular, see PEP 8. This is fixed in my reviewer patch; see trac-9655_reviewer.patch. Someone other than me needs to review that. If my patch gets a positive review, the whole ticket gets a positive review.

I was unaware of such conventions...

comment:6 Changed 5 years ago by mvngu

Replying to olazo:

At some point I recieved a warning about User not being defined, but how do I set it up? I mean other than directly editing the .patch

You should use the Mercurial configuration file ~/.hgrc. Here's a template for your ~/.hgrc file:

[ui]
editor = /usr/bin/vim
username = Carl Friedrich Gauss <cfgauss@uni-goettingen.de>

[extensions]
# Enable the Mercurial queues extension.
hgext.mq =
# Enable the record, qrecord and crecord extensions for cherry picking.
hgext.record =

[diff]
# Format diff output using Git style.
git = True
# Prevent qrefresh from updating timestamps. If you're keeping your patch
# queue under revision control, it can be quite annoying when every qrefresh
# updates the timestamps in your patch. The following prevents this from
# happening.
nodates = 1

Change your username accordingly.


I was unaware of such conventions...

See this page of the Developer's Guide for more details about coding conventions used by the Sage library.

comment:7 Changed 5 years ago by spice

  • Status changed from needs_review to positive_review

comment:8 follow-up: Changed 5 years ago by spice

This is the first patch I've ever reviewed, so a second look by someone else might not be a bad idea.

comment:9 in reply to: ↑ 8 Changed 5 years ago by mvngu

Replying to spice:

This is the first patch I've ever reviewed, so a second look by someone else might not be a bad idea.

Please put down your real name in the field "Reviewer(s):".

comment:10 Changed 5 years ago by spice

  • Reviewers changed from Minh Van Nguyen to Minh Van Nguyen, Simon Spicer

comment:11 Changed 5 years ago by spice

  • Reviewers changed from Minh Van Nguyen, Simon Spicer to Simon Spicer

comment:12 Changed 5 years ago by spice

Done.

Thanks Minh.

comment:13 Changed 5 years ago by jdemeyer

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