[Numpy-discussion] finding docs (was: unique1d docs)

Alan G Isaac aisaac@american....
Tue Dec 16 09:01:12 CST 2008


On 12/16/2008 1:29 AM Jarrod Millman apparently wrote:
> Yes.  Please don't start new moin wiki documentation.  We have a good
> solution for documentation that didn't exist when the moin
> documentation was started.  Either put new docs in the docstrings or
> in the scipy tutorial.


OK, in this case I think the main NumPy needs a change:
an explicit link to the new docs,
and a section titled "Documentation" (linked in the contents),
and an explict link to the new Numpy Reference Guide.

As far as I can tell, I have no way to edit this page:
http://numpy.scipy.org/

Imagine a new user looking for docs.
This is what I think they would do.

1. Use `numpy` as a browser search term,
and get directed to http://numpy.scipy.org/

2. Notice no "Docmentation" link in contents.
*Maybe* notice that "Download the Guide" means
get some documentation, but probably that is
more detailed and encyclopedic than many are
first seeking.

3. Perhaps they will read the text and get pointed
to the Numeric docs.

Nothing will point them to the new docs. They
may notice "Other Documentation is available
at the scipy website" but if they follow that,
will they guess that they should try a "snapshot"
of a "work in progress"?

Alan Isaac



More information about the Numpy-discussion mailing list