[Numpy-discussion] Procedure for doing documentation reviews

[Ralf Gommers]

On Mon, Oct 26, 2009 at 2:16 AM, David Goldsmith <d.l.goldsmith at gmail.com>wrote:

> Technically, after "Needs Review," it's supposed to go through "Needs Work
> (Reviewed)"  The "by the book" way to do it would be to:
>
> 0 & 1) Provide comments in the Discussion section and change status to
> "Needs Work (Reviewed)" (in either order);
>
> 2) Edit, if inclined.
>
> 3) Answer your own comments as a record of what you've done;
>
> 4) At the end of all this, if you feel it's ready for review again, change
> status to "Needs Review (Revised)."
>
> Thanks!
>
> DG
>
>
> On Sun, Oct 25, 2009 at 5:42 PM, Christopher Burns <cburns at berkeley.edu>wrote:
>
>> When a documents status is "Needs Review" and when reviewing it we
>> feel it needs edits, should we add comments regarding the edits, or
>> should we feel free to edit it directly?
>>
>> If they are largish changes, then what David said. If they are minor
changes though, just edit away (I do that all the time).

For example, if you see some mistakes in type descriptions, just fix them.
If you feel a whole section is unclear and needs a rewrite, follow the
review procedure.
In between, exercise your good judgment.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20091026/d36f070d/attachment.html>