The SymPy docs are quite fine but I feel most of the modules could use a lot more comments(in-line and block, existing docstrings are already quite good !) It would make it easier for contributors(especially new ones) to fix bugs if there were comments explaining the underlying algorithm/math.
Here <https://github.com/sympy/sympy/blob/master/sympy/integrals/integrals.py#L846> is a good example of what I mean(lines 846 to 1066 have a fairly decent explanation of the process used). Unfortunately such comments seem rare to me throughout the library. On Thursday, March 14, 2019 at 12:35:31 AM UTC+5:30, Aaron Meurer wrote: > > Google is starting a new program, Google Season of Docs (GSoD). I'd > like to gauge the community's interest in applying. > > Full information about the program is here: > https://developers.google.com/season-of-docs/ > > The program is very similar to Google Summer of Code, but unlike GSoC, > it focuses on documentation instead of code. Also unlike GSoC, the > program is aimed toward people with technical writing experience > rather than students. The idea is to give open source projects a > chance to have a professional technical writer help them with their > documentation. The technical writers learn more about open source > technologies and get something they can add to their resume. > > Should SymPy apply? The application period intersects with GSoC a bit, > but the actual mentoring period does not > (https://developers.google.com/season-of-docs/docs/timeline). > > Aaron Meurer > -- You received this message because you are subscribed to the Google Groups "sympy" group. To unsubscribe from this group and stop receiving emails from it, send an email to sympy+unsubscr...@googlegroups.com. To post to this group, send email to sympy@googlegroups.com. Visit this group at https://groups.google.com/group/sympy. To view this discussion on the web visit https://groups.google.com/d/msgid/sympy/76b1e451-00ac-490c-a26b-1cc0d9ccec00%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
