#5996: [with patch, needs review] Wigner 3j, 6j, 9j, Clebsch-Gordan, Racah and
Gaunt coefficients
-------------------------+--------------------------------------------------
Reporter: jrasch | Owner: burcin
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.1.1
Component: calculus | Keywords:
Reviewer: | Author: Jens Rasch
Merged: |
-------------------------+--------------------------------------------------
Comment(by mvngu):
I'm reviewing the coding style and docstring formatting. Here are some
problems I notice with the coding style:
1. It doesn't follow many of the coding conventions in the
[http://www.sagemath.org/doc/developer/conventions.html Developers'
Guide]. In particular, don't use camel case for function name. The
following functions are currently in camel case: {{{Wigner3j}}},
{{{ClebschGordan}}}, {{{_bigDeltacoeff}}}, {{{Racah}}}, {{{Wigner6j}}},
{{{Wigner9j}}}, {{{Gaunt}}}.
1. The Python code is mostly squashed together and makes little use of
white space. For example, instead of writing a function signature like
this:
{{{
def _bigDeltacoeff(aa,bb,cc,prec=None):
}}}
it should be written as follows:
{{{
def _big_delta_coeff(aa, bb, cc, prec=None):
}}}
which makes use of white space so it doesn't look like code is squashed
together. Another example, don't do this
{{{
if(int(aa+bb-cc)!=(aa+bb-cc)):
}}}
Instead, write it like this:
{{{
if int(aa + bb - cc) != (aa + bb - cc):
}}}
This means that the whole module needs to be reformatted to make use of
white space.
1. The docstring of some functions don't follow the guidelines
[http://www.sagemath.org/doc/developer/conventions.html#docstring-content
here]. In particular, the docstring should be organized with the following
two items first:
1. A one-sentence description of the function, followed by a blank line.
1. An INPUT and an OUTPUT block for input and output arguments (see
below for format). The type names should be descriptive, but do not have
to represent the exact Sage/Python types. For example, use “integer” for
anything that behaves like an integer; you do not have to put a precise
type name such as int.
If no one beats me to it, I'll upload a patch to address the issues I
raised above.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5996#comment:10>
Sage <http://sagemath.org/>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---
