On Nov 20, 6:22 pm, kcrisman <[EMAIL PROTECTED]> wrote:
Hi, > > possible since in 3.3 we will convert the docstrings to ReST. This > > will likely break most patches not merged into 3.2.1. > <snip> > > around here is telling you what to do, but since the ReST transition > > will be painful otherwise please consider that into your plans. > > I've been looking at the discussions about ReST and seen the Wiki page > about it, but I'm not sure how that will actually impact Sage. In > particular, if we are not including $$ stuff in a docstring, will > anything change for how to write docstrings? Or will we not be > writing docstrings in code itself at all? I looks like the markup > will simply change, but I'm not sure. There will be markup changes. One big advantage will be that the documentation will build much more quickly, we do ship all of the dependencies to build the documentation, i.e. no LaTeX setup any more, and it will look much better. Upstream python also changed to use it and many other python projects have also followed suite. > I'm sorry if this is described somewhere, but I couldn't figure out > where that would be located. A sample of "before" and "after" > docstrings would be very helpful, especially for those of us who have > patches that need some work and won't be ready for 3.2.1 or for a > while after that. Yeah, part of 3.3 (or maybe even 3.2.1) should be ample documentation and hopefully also some addition to the manual about docstrings and doctesting. Most of the translation now will be via some scripts and a low amount of human post processing, so hopefully patches post the big switch can be run through some automated process to spare users the pain of conversion. > Thanks, > - kcrisman Cheers, Michael --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
