Hi John, > > I'm working on #9128 whose goal is to resolve dangling links by looking in > > python docs and in sage.all. On the way, I noticed that there are lots of > > todos in the doc but no systematic way to handle them in sage. Fortunately, > > there is a nice sphinx extension to handle them and gather them in a nice > > todo > > list. I just created #11251 "Add todo extension to Sphinx" which allows to > > use it as e.g.: > > > > .. todo:: Should be optimized using Cython > > > > Is there any objection to use it ? > > > Not from me. I like the idea of getting more consistency in the > documentation by using more Sphinx mark-up and extensions. > > > At this point, I changed one todo as an example but did not systematically > > change all the todos to avoid conflicts: the parts of sage bearing most > > todos > > are those most likely to be under heavy development. Besides I didn't have > > the > > time to do it ;-). I think it will be easier to instead change those > > progressively, after a test period. > > > > Do you agree with this approach? > > > It seems like a good idea to me. Should we also add a comment to the > developer's guide about this kind of mark-up for the documentation?
Good idea. Done. Florent -- To post to this group, send an email to sage-devel@googlegroups.com To unsubscribe from this group, send an email to sage-devel+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URL: http://www.sagemath.org
