PySoy: Sphere Comments
completed by: Samuel Kim
mentors: Amaury Medeiros, Arc Riley, Tony Young, David Czech, Mayank Singh
soy.bodies.Sphere works, but its rendering code is very lengthy
with very few source comments. This makes debugging it very difficult.
If you can understand the code, go through it and heavily comment its
steps, including ascii diagrams (as
soy.bodies.Box has) showing
how the verticies and faces are determined. Add a comment for any variable
who's purpose/function can't be determined by its name alone, every for loop,
and every conditional. There should be at least one line of comment per line
of code, ideally closer to twice as many comments.
While doing this, correct any long (>80 character) lines, lack of space between operators and values, and generally try to make the code as readable as possible.
If you cannot understand what the code is doing do not take this task. It is not the job of mentors to explain this code to you.
While working on this task you should join and remain in #PySoy on Freenode to get help, feedback, and guidance from mentors and other developers. Code updates which may affect your work are also announced here as they happen. This is especially important for this task as other GCI tasks may be worked on to modify the same function.
When you've done, commit your work and post the resulting changeset url to this task.