2009/1/3 mabshoff <mabsh...@googlemail.com>: > > > > On Jan 3, 10:00 am, "John Cremona" <john.crem...@gmail.com> wrote: >> 2009/1/3 mabshoff <mabsh...@googlemail.com>: >> >> >> >> >> >> > On Jan 3, 9:34 am, "John Cremona" <john.crem...@gmail.com> wrote: >> >> > Hi John, >> >> >> A different but related point: where is it decided which source files >> >> are converted into documentation and which are not? For example, in >> >> the hyperelliptic curves section there are several files with almost >> >> nothing in them; while in the elliptic curves section there's nothing >> >> from files ell_point.py and weierstrass_morphism.py (and maybe >> >> others). >> >> >> John >> >> > In the old documentation this was controlled via devel/doc/ref/files, >> > I am not sure how this is controlled in the new documentation. One >> > aspect of this review is certainly to get more of the files in Sage >> > into the documentation, i.e. so far neither the Species code nor the >> > SageWords library is in 3.2.3's ref manual. But they are in 3.3, so if >> > you see some files with nice docstrings that is not in the ref manual >> > please open a ticket to get them in. >> >> I have done so (#4933), as there 16 files in >> sage.schemes.elliptic_curves which are missing! > > Thanks for doing this. If anybody else notices similar issues please > also open a ticket. > >> The sickening thing is that this was not done before, since these 16 >> files have escaped the conversion to Sphinx. I had wrongly assumed >> that the change to REST had been carried out on every source file, but >> not so... > > Well, so far only the files in the documentation have been converted, > but I am sure those additional files will also be converted by Mike > once the big rush for 3.3 is over. He did mention at some point that > maybe 50 or so files are unconverted at this point, but that number > might be wrong due to my bad recollection. Either way, the switch to > ReST will flush out all kinds of issues like this and also will make > people look at files that just have been sitting there for a while. In > the end it is a good thing, even though it introduces short term pain.
Yes, definitely! Perhaps we could have a doc-day devoted to converting remaining files: using Mike's script + manuall/viual checking afterwards. John > >> John > > Cheers, > > Michael > > > --~--~---------~--~----~------------~-------~--~----~ To post to this group, send email to sage-devel@googlegroups.com To unsubscribe from this group, send email to sage-devel-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/sage-devel URLs: http://www.sagemath.org -~----------~----~----~----~------~----~------~--~---
