Re: [Numpy-discussion] New documentation web application
On Thu, 29 May 2008 17:48:10 -0500 Nathan Bell [EMAIL PROTECTED] wrote: On Thu, May 29, 2008 at 5:28 PM, Stéfan van der Walt [EMAIL PROTECTED] wrote: Hi all, The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Unfortunately, this means that those of you who signed up before will have to create new accounts at http://sd-2116.dedibox.fr/pydocweb Neat! I really like the layout. The red format warnings are a nice touch: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.core.umath.exp/ -- Nathan Bell [EMAIL PROTECTED] http://graphics.cs.uiuc.edu/~wnbell/ The doc is excellent. Thanks. But I am missing a more developped form of the numpy entry page http://sd-2116.dedibox.fr/pydocweb/doc/numpy/ with a brief description for every class or function Example: trim_zeros : Trim the leading and trailing zeros from a 1D array. or is there a way to get this on a html-page ? -- R. Bastian www.musiques-rb.org ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
Hi Bastian 2008/5/31 R. Bastian [EMAIL PROTECTED]: On Thu, 29 May 2008 17:48:10 -0500 Nathan Bell [EMAIL PROTECTED] wrote: On Thu, May 29, 2008 at 5:28 PM, Stéfan van der Walt [EMAIL PROTECTED] wrote: Hi all, The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Unfortunately, this means that those of you who signed up before will have to create new accounts at http://sd-2116.dedibox.fr/pydocweb Neat! I really like the layout. The red format warnings are a nice touch: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.core.umath.exp/ -- Nathan Bell [EMAIL PROTECTED] http://graphics.cs.uiuc.edu/~wnbell/ The doc is excellent. Thanks. But I am missing a more developped form of the numpy entry page http://sd-2116.dedibox.fr/pydocweb/doc/numpy/ with a brief description for every class or function Example: trim_zeros : Trim the leading and trailing zeros from a 1D array. or is there a way to get this on a html-page ? Sure, that is very easy. I can generate it as part of the reference guide. I'll send you a link this evening. Regards Stéfan ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
On Sat, May 31, 2008 at 4:05 AM, R. Bastian [EMAIL PROTECTED] wrote: Neat! I really like the layout. The red format warnings are a nice touch: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.core.umath.exp/ Hi, I was just reading through this example when I noticed this usage: from matplotlib import pyplot as plt Although this is of course perfectly valid python, I have been encouraging people when importing modules from packages to use the syntax: import somepackage.somemodule as somemod rather than from somepackage import somemodule as somemod The reason is that in the first usage it is unambiguous that somemodule is a module and not a function or constant. Eg, both of these are valid python: In [7]: from numpy import arange In [8]: from numpy import fft but only the module import is valid here: In [3]: import numpy.fft as fft In [4]: import numpy.arange as arange ImportError Traceback (most recent call last) ImportError: No module named arange I taught a class on scientific computing in python to undergraduates, and the students were frequently confused about what was a module and what was a function. If you are coming from matlab, you are likely to think fft is a function when you see this: from numpy import fft By being consistent in importing modules using the 'import numpy.fft as fft', it can make it more clear that we are importing a module. I already recommend this usage in the matplotlib coding guide, and numpy may want to adopt it as well. JDH ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
Hi, By being consistent in importing modules using the 'import numpy.fft as fft', it can make it more clear that we are importing a module. I already recommend this usage in the matplotlib coding guide, and numpy may want to adopt it as well. That's an excellent suggestion, seconded. Matthew ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
Matthew Brett wrote: Hi, By being consistent in importing modules using the 'import numpy.fft as fft', it can make it more clear that we are importing a module. I already recommend this usage in the matplotlib coding guide, and numpy may want to adopt it as well. That's an excellent suggestion, seconded. +1 -Travis ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
[Numpy-discussion] New documentation web application
Hi all, The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Unfortunately, this means that those of you who signed up before will have to create new accounts at http://sd-2116.dedibox.fr/pydocweb Please, don't let this put you off! You have made great contributions so far, and you *will* see these changes in the next release of NumPy (1.2). Being able to say that you wrote part of the NumPy documentation certainly is something to be proud of! Please mail me or Pauli your usernames, and we shall add you to the editor or reviewer groups ASAP. The new web application has a number of advantages: - We can set the status of docstrings, e.g., modfied, in need of review, reviewed, in need of proof, proofed etc. - We can easy keep the docstrings in sync with the current SVN. This means that the developers can add to the docstrings without adversely influencing our effort. - We can keep track of documentation statistics, e.g., how many docstrings have an Examples section? - Docstrings are parsed according to the documentation standard, and displays as they would be in the reference guide. Again, please register at http://sd-2116.dedibox.fr/pydocweb To all those who have contributed so far, a big thank you! It is because of you that the author field of the Reference Guide reads The Numpy Community. Regards Stéfan ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
On Thu, May 29, 2008 at 3:28 PM, Stéfan van der Walt [EMAIL PROTECTED] wrote: The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Excellent. Thanks to everyone who is working on this. The documentation work that you are doing is going to make a huge difference in increasing NumPy adoption and will benefit the community in a major way. Thanks, -- Jarrod Millman Computational Infrastructure for Research Labs 10 Giannini Hall, UC Berkeley phone: 510.643.4014 http://cirl.berkeley.edu/ ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
2008/5/29 Jarrod Millman [EMAIL PROTECTED]: On Thu, May 29, 2008 at 3:28 PM, Stéfan van der Walt [EMAIL PROTECTED] wrote: The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Excellent. Thanks to everyone who is working on this. The documentation work that you are doing is going to make a huge difference in increasing NumPy adoption and will benefit the community in a major way. Absolutely. It is also, already, improving the reliability and consistency of numpy's code as people carefully go over all the functions that have been neglected for years. This is a great project. Anne ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
Re: [Numpy-discussion] New documentation web application
On Thu, May 29, 2008 at 5:28 PM, Stéfan van der Walt [EMAIL PROTECTED] wrote: Hi all, The NumPy documentation project has taken another leap forward! Pauli Virtanen has, in a week of superhuman coding, produced a web application that enhances the work-flow and editing experience of NumPy docstrings on the web. Unfortunately, this means that those of you who signed up before will have to create new accounts at http://sd-2116.dedibox.fr/pydocweb Neat! I really like the layout. The red format warnings are a nice touch: http://sd-2116.dedibox.fr/pydocweb/doc/numpy.core.umath.exp/ -- Nathan Bell [EMAIL PROTECTED] http://graphics.cs.uiuc.edu/~wnbell/ ___ Numpy-discussion mailing list Numpy-discussion@scipy.org http://projects.scipy.org/mailman/listinfo/numpy-discussion
