Issue 1196: improve our examples http://code.google.com/p/sympy/issues/detail?id=1196
Comment #2 by andy.terrel: To me examples are really important, they provide a first look into a code and can often give misleading advice. Two things that I think would be good: 1) Have staged levels of math competence for examples. Not everyone using sympy should need a higher degree in the mathematical sciences to know what is going on. I think it we should really separate things that a primary school education should understand and quantum physics. 2) Having examples work as a much as possible, perhaps a standing issue for every release or commit to have all examples work. Just like tests. 3) Require somewhat detailed docstrings that give links to mathematical concepts and algorithms. For example with a better directory structure would be good: - examples/beginner -- things like basic.py, differentiations.py - examples/intermediate -- things like differential_eqations, vandermonde.py, ... - examples/advanced -- things like fem.py, tensors.py -- 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 -~----------~----~----~----~------~----~------~--~---
