Improve documentation in functions/wigner.py

sagemath / sage

Main repository of SageMath

https://www.sagemath.org

Other

1.39k stars 473 forks source link

Improve documentation in functions/wigner.py #20903

Closed 53959995-fd20-47f5-85e6-5e769b863d1f closed 8 years ago

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

CC: @rwst

Component: documentation

Author: Paul Masson

Branch/Commit: 0a8232d

Reviewer: Ralf Stephan

Issue created by migration from https://trac.sagemath.org/ticket/20903

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

Author: Paul Masson

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

Branch: u/paulmasson/improve_documentation_in_functions_wigner_py

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

Commit: 5a8e778

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

comment:3

This file hasn't seen much love since 2009. I've added the proper notation for the symbols, fixed the definition of the Gaunt coefficient and conformed symbol names to Edmonds.

New commits:

`d28bb74`	`Break long lines with minimal LaTeX`
`c338bc5`	`Typo`
`64b98d2`	`Conform symbol names to Edmonds`
`be72c48`	`Make angular momenta consistent in Gaunt`
`a912c97`	`Definition of Gaunt incorrect`
`43cd6ab`	`Proper notation for 9-j symbol`
`af2a29d`	`Proper notation for 6-j symbols`
`4ed355f`	`Proper notation for 3-j symbols`
`1fcc21a`	`Proper notation for 6-j symbols`
`5a8e778`	`Proper notation for 3-j symbols`

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

comment:4

Ralf, could you please have a look at this ticket so that it makes it into 7.3? The changes are cosmetic apart from putting 3-j symbols into the definition of the Gaunt coefficient. Thanks!

rwst commented 8 years ago

Reviewer: Ralf Stephan

rwst commented 8 years ago

comment:5

I only found this issue, could you please address it:

sage.functions.wigner.racah(aa, bb, cc, dd, ee, ff, prec=None) but after INPUT reference is made to a,...,f

The LaTeX looks fine and you can set positive after the above change.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 8 years ago

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

0a8232d Minor update to Racah symbol

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 8 years ago

Changed commit from 5a8e778 to 0a8232d

53959995-fd20-47f5-85e6-5e769b863d1f commented 8 years ago

comment:7

Since this ticket is about documentation, I made the displayed variables match those used in the code. The code could be updated to use more appropriate variables on another ticket.

vbraun commented 8 years ago

Changed branch from u/paulmasson/improve_documentation_in_functions_wigner_py to 0a8232d