[SciPy-Dev] "Census" of scipy docstrings needing editing attention

[Ralf Gommers]

On Wed, May 5, 2010 at 9:37 AM, <josef.pktd at gmail.com> wrote:

> On Tue, May 4, 2010 at 8:55 PM, David Goldsmith <d.l.goldsmith at gmail.com>
> wrote:
> > On Tue, May 4, 2010 at 5:04 PM, Warren Weckesser
> > <warren.weckesser at enthought.com> wrote:
> >>
> >> Is there an explanation somewhere of the connection between the
> >> docstrings in the source and the docstrings visible at docs.scipy.org?
>

In a bunch of mailing list posts only I'm afraid. Time to write that down
somewhere. Basically, changes made in svn propagate to the wiki every day,
and get either merged automatically or end up on the Merge page if there's a
conflict. The other way around merging is manual, the procedure is explained
in HOWTO_MERGE_WIKI_DOCS.txt under numpy/doc/. Before merging back these
should be reviewed from the Patch wiki page (you'd need to ask for rights
again to do that, not the same as edit rights).

For fixing basic typos etc. it is probably more convenient for you to do
that in svn, but as David G. pointed out it'd be good to have significant
changes/additions done in the wiki, then it's much more visible what the
history for that docstring was and its current status.

That's it in a nutshell. Wiki dev site and issues are at
http://code.google.com/p/pydocweb/.


> >> I've made an assortment of changes (via svn) in scipy.linalg and
> >> scipy.signal, including the module-level docstrings, but I don't see the
> >> changes on the web page.  For example,
> >>    http://docs.scipy.org/scipy/docs/scipy-docs/linalg.rst/
> >> is not up to date.
>

This is strange, seems to be a bug. Maybe the wiki server refuses to pull
from svn ATM or something like that.


>
>  I don't know why this doesn't indicate a conflict:
> http://docs.scipy.org/scipy/docs/scipy-docs/signal.rst/
>
> That looks fine, just a few changes on top of what's in svn.


> step2 is in source, but doesn't show in edit, nor in  "Diff to SVN"
> changes that were made in the doc editor are there
>
> step2 is not in the doceditor according to a search
>

step2 was added less than 2 days ago, changes can take that amount of time
to propagate.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20100505/3b822149/attachment.html>