Maybe separate Sphinx documentation would be the clearest, like you did with the Meijer G stuff.
Aaron Meurer On Jun 10, 2012, at 1:29 PM, Tom Bachmann <[email protected]> wrote: > On 10.06.2012 21:20, Aaron Meurer wrote: >> Ah. I guess I was thinking specifically that it should be in the class >> docstrings. At least that's where I was looking for them. >> > > But it makes more sense with the actual methods, doesn't it? Or should I > include an overview of all the provided methods and theoretical background in > the class docstring? > >> Aaron Meurer >> >> On Jun 10, 2012, at 12:36 PM, Tom Bachmann<[email protected]> wrote: >> >>> On 10.06.2012 17:53, Aaron Meurer wrote: >>>> In a similar vein, I was going to suggest that you put some >>>> mathematical info in all the base class docstrings, so that someone >>>> coming to the code who has no idea what something like a syzygy is can >>>> at least get an idea without trying to read the Wikipedia article. >>>> >>> >>> Hm. I was under the impression I am doing this. For example: >>> >>> def syzygy_module(self, **opts): >>> r""" >>> Compute the syzygy module of the generators of ``self``. >>> >>> Suppose `M` is generated by `f_1, \dots, f_n` over the ring >>> `R`. Consider the homomorphism `\phi: R^n \to M`, given by >>> sending `(r_1, \dots, r_n) \to r_1 f_1 + \dots + r_n f_n`. >>> The syzygy module is defined to be the kernel of `\phi`. >>> >>> The syzygy module is zero iff the generators generate freely a free >>> submodule: [...] >>> >>> What else should I mention here? >>> >>>> By the way, I'm almost done reviewing them. I just have to finish the >>>> last one. I was on vacation this week, so it got stalled, but I plan >>>> to do so next week when I get back. >>>> >>> >>> That sounds great, thank you very much. >>> >>> -- >>> 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. >>> >> > > -- > 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. > -- 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.
