On Thu, Nov 12, 2009 at 6:24 AM, smichr <smi...@gmail.com> wrote:
>
> I'm just looking for some feedback about what is useful to see in the
> documentation. I've finished making all imports explicit in the *py
> files and am wondering what is most useful to see in the
> documentation.
>
> What should the following be replaced with:
>
>>>> from sympy import *
>>>> var('x')
>>>> print sqrt(x)
>
> A
>>>> from sympy.abc import x
>>>> from sympy import sqrt
>>>> print sqrt(x)
> x**(1/2)
>
> B
>>>> import sympy
>>>> print sympy.sqrt(x)
> x**(1/2)
>
> C
>>>> import sympy as s
>>>> s.var('x')
> x
>>>> print s.sqrt(x)
> x**(1/2)
>
> If we are trying to get people to learn what's in sympy, the s.foo
> format is the most direct instructional format, I think. Are there
> other ideas? What do you think?

I don't have any strong feelings on this, as long as it is explicit,
e.g. all A, B, C is fine.

I myself just use a combination of A/B. I don't like C much. Saving 3
characters, e..g "np" instead of "numpy" --- well, I don't find it
worthy. Saving 2 characters in "smp" instead of "sympy", well, that
sounds even less worthy to me. But as I said, I think it's up to you.
I think we can even combine all A/B/C in the docs.

Ondrej

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

Reply via email to