-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 06/12/11 01:58, Pauli Virtanen wrote: > I think this cannot be helped --- it does not make sense to explain > basic Numpy concepts in every docstring, especially `axis` and `shape` > are very common.
They don't need to be explained on the page, but instead link to a page that does explain them. The test is that an experienced Python programmer should be able to understand what is going on from the fft doc page and every page it links to. Note that searching doesn't help: http://docs.scipy.org/doc/numpy/search.html?q=axis http://docs.scipy.org/doc/numpy/search.html?q=shape > However, an example with the axis keyword could be useful. And examples not using "square" inputs. With an input that has a long edge (eg time) and a short edge (value(s)) it is a lot easier to understand what is going on. Roger -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.11 (GNU/Linux) iEYEARECAAYFAk7eQ5gACgkQmOOfHg372QQpzQCeNO7evHqLaKNNQIzHbDLY3RVD HmwAn1MGH6DdJND5lKINwAFXzLbDry5J =xycq -----END PGP SIGNATURE----- _______________________________________________ NumPy-Discussion mailing list [email protected] http://mail.scipy.org/mailman/listinfo/numpy-discussion
