On Wed, Jun 24, 2009 at 8:35 PM, Aaron S. Meurer<[email protected]> wrote:
>
> I think one thing we need to do is go through and spellcheck and
> grammar check (for those of us who are native english speakers) all of
> the documentation, and maybe the comments too.  I know I see errors
> all of the time, and most people probably do not use a spellchecker in
> their editor (even I am guilty of this).  Is there an easy way to pull
> all of these into a text document that can be run through spellchecker
> and put back again afterwords?

That'd be really helpful, thanks a lot. It's not only about spell
checker, but also
about word order and articles (like "code" vs "a code") etc.

As to spellchecker, I think there is some package to vim, but what I
usually do, I just load the whole file in openoffice, see where the
errors are, correct them in openoffice, save it and then use "git
diff" to see if openoffice save the file correctly and if it didn't
(e.g. it spolied lineends and other things) I use "git add -p" to only
add the word corrections.

>
> Aside from that, one thing that I found lacking in the documentation
> the most when I first started using SymPy was a simple introduction/
> tutorial that showed some basic things that you could do to get you
> started.  Maybe this exists but I couldn't really find it.  Or I think
> there was one but it wasn't all that great.

This is our tutorial:

http://docs.sympy.org/tutorial.html

Do you have some ideas how it could be improved?

>
> And of course, we can always add/improve docstrings.

Definitely.

Ondrej

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sympy" 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/sympy?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to