Status: Accepted
Owner: smichr
Labels: Type-Defect Priority-Medium

New issue 1517 by smichr: galgebra.GA docstrings
http://code.google.com/p/sympy/issues/detail?id=1517

Some of the docstrings are puzzling in GA and need some attention:

###
def symbol(sym_str):
     """
     Symbol converts a string to a sympy/sympy symbol.
     """
###
should this say numpy/sympy?

###
def collect(expr,lst):
     """
     Wrapper for sympy.collect and sympy.collect.
     See references 2, 3, and 4.
     """
     lst = MV.scalar_to_symbol(lst)
     return(sympy.collect(expr,lst))
###
should this say sympy.collect and sympy.factor?

###
def sqrfree(expr,lst):
     """
     Wrapper for sympy.sqrfree and sympy.factor.
     See references 2, 3, and 4.
     """
     return(sympy.sqrfree(expr,lst))
###
this, as for others, appears to be only a single call not a combination of
calls like sqrfree and factor.

###
def collect_common_factors(expr):
     """
     Wrapper for sympy.collect_common_factors and sympy.factor.
     See references 2, 3, and 4.
     """
     return(sympy.collect_common_factors(expr))
###
this isn't even a sympy method as far as I can tell.

/c

--
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sympy-issues" group.
To post to this group, send email to sympy-issues@googlegroups.com
To unsubscribe from this group, send email to 
sympy-issues+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/sympy-issues?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to