Status: Accepted Owner: asmeurer Labels: Type-Defect Priority-Medium NeedsReview
New issue 1519 by asmeurer: Add Gotchas and Pitfalls documentation as well as Sphinx docs for simplify functions http://code.google.com/p/sympy/issues/detail?id=1519 This is my contribution to Documentation Day 2009. The gotchas and pitfalls document is a bunch of things that people new to SymPy, Python, or both might not know. For example, it goes over some of the major syntax difference between SymPy and other major CAS's (like ** for power), and it also goes over what some of the special symbols mean in Python (like [({). This also adds a basic file that has all of the docstrings from the simplify module. I had to change the docstrings of some of the functions in simplify.py so that they use == Header == instead of Header ======= because it was making the autodocs fail. Apparently, docstrings take on Sphinx formatting when they are pulled in by autodoc, which means headers cannot be on top of a string of ='s or -'s. Pull from http://github.com/asmeurer/sympy/tree/doc-day. -- 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 [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-issues?hl=en -~----------~----~----~----~------~----~------~--~---
