On Sat, Nov 14, 2009 at 01:58:23PM -0800, Robert Bradshaw wrote: > > One good habits which will probably solve a large part of the > > duplicate it to > > put the reference not in the doctring of the methods or function but > > in that > > of the module = file. It is very likely that several methods/ > > function or > > related to the same paper will appear. It is as well likely that > > they appear > > in the same class/file. Also, it's coherent to put them close to the > > AUTHOR: > > part since both are some kinds of acknowledgment (one for the > > mathematical > > idea, one for the implantation). > > I'm not sure this will be a good thing--it might make a cleaner > reference manual but I think docstrings are most used via the powerful > introspection that's available in Sage, and we want to put as much as > possible (e.g. references) right at the user's fingertips. >
I strongly agree with Robert here, I wouldn't want to break introspection. Moreover, this doesn't solve the problem of the same reference being cited from different files (and this is not just a hypothetical situation, I've run into it with steenrod_algebra.py and steenrod_algebra_element.py, and I think it also comes up in the graphs code). Best, Alex -- Alex Ghitza -- Lecturer in Mathematics -- The University of Melbourne -- Australia -- http://www.ms.unimelb.edu.au/~aghitza/ --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
