Hi, I've quickly gone through and done some cross-referencing of docstrings in scipy. Only the modules interpolate, integrate, and optimize have cross-references so far. I looked at special, but there are so many special functions I'm not sure what to do (for example, should the docstring on Bessel functions list modified Bessel functions? spherical Bessel functions?). That's all the packages I've had occasion to use, so the others would take longer. I'm afraid the cross-referencing is not neccessarily very consistent in formatting, but then neither are the docstrings themselves. A. M. Archibald
A. M. Archibald wrote:
Hi,
I've quickly gone through and done some cross-referencing of docstrings in scipy.
Thank you! For future patches, please create a ticket in our Trac. Due to spam, you will have to create an account, first. The option to attach a file is, confusingly, exposed after the ticket is created. http://projects.scipy.org/scipy/scipy http://projects.scipy.org/scipy/scipy/register -- Robert Kern "I have come to believe that the whole world is an enigma, a harmless enigma that is made terrible by our own mad attempt to interpret it as though it had an underlying truth." -- Umberto Eco
On 23/09/06, Robert Kern <robert.kern@gmail.com> wrote:
A. M. Archibald wrote:
Hi,
I've quickly gone through and done some cross-referencing of docstrings in scipy.
Thank you! For future patches, please create a ticket in our Trac. Due to spam, you will have to create an account, first. The option to attach a file is, confusingly, exposed after the ticket is created.
Ah, thanks. I wasn't sure anybody read the trac. A. M. Archibald
A. M. Archibald wrote:
On 23/09/06, Robert Kern <robert.kern@gmail.com> wrote:
A. M. Archibald wrote:
Hi,
I've quickly gone through and done some cross-referencing of docstrings in scipy. Thank you! For future patches, please create a ticket in our Trac. Due to spam, you will have to create an account, first. The option to attach a file is, confusingly, exposed after the ticket is created.
Ah, thanks. I wasn't sure anybody read the trac.
We do. We don't necessarily have time to act on the tickets, but posting patches to the list doesn't change that. -- Robert Kern "I have come to believe that the whole world is an enigma, a harmless enigma that is made terrible by our own mad attempt to interpret it as though it had an underlying truth." -- Umberto Eco
A. M. Archibald wrote:
Hi,
I've quickly gone through and done some cross-referencing of docstrings in scipy. Only the modules interpolate, integrate, and optimize have cross-references so far. I looked at special, but there are so many special functions I'm not sure what to do (for example, should the docstring on Bessel functions list modified Bessel functions? spherical Bessel functions?).
I'd suggest just leaving most of it alone. The categorized info.py is probably more useful.
That's all the packages I've had occasion to use, so the others would take longer.
I've checked in most of your patch. I have local modifications to interpolate.py that I will check in later today with your cross-reference information.
I'm afraid the cross-referencing is not neccessarily very consistent in formatting, but then neither are the docstrings themselves.
Heh. You ain't kidding. -- Robert Kern "I have come to believe that the whole world is an enigma, a harmless enigma that is made terrible by our own mad attempt to interpret it as though it had an underlying truth." -- Umberto Eco
participants (2)
-
A. M. Archibald -
Robert Kern