[SciPy-Dev] Contributing to the Documentation

Juan Luis Cano juanlu001@gmail....
Thu Aug 1 16:10:46 CDT 2013


On 08/01/2013 10:41 PM, Ralf Gommers wrote:
>
>
>
> On Thu, Aug 1, 2013 at 10:37 PM, Andreas Hilboll <lists@hilboll.de 
> <mailto:lists@hilboll.de>> wrote:
>
>     Am Do 01 Aug 2013 22:22:02 CEST schrieb Juan Luis Cano:
>     > On 08/01/2013 07:56 PM, Ralf Gommers wrote:
>     >>
>     >>     On the contribution page you encourage enhancements to scipy's
>     >>     documentation - is still so, and - if yes - do you prefer pull
>     >>     requests
>     >>     (via Github) or is it better to use the documentation wiki?
>     >>
>     >>
>     >> We indeed prefer pull requests, those are quite a bit easier to
>     >> review and merge. We keep the documentation wiki for people who
>     just
>     >> want to make a quick edit or are uncomfortable working with git.
>     >
>     > What about the "Edit" button on GitHub?
>
>     That just creates a fork and sends a pull request, all "under the
>     hood".
>
>
> I think Juan knows that, the question is whether we'd like people to 
> use that instead of the doc wiki. To be honest I don't know, haven't 
> tried it myself yet. If it works well then maybe yes, but probably 
> only for small edits (unless you can go back and add more commits to 
> the same PR.
>
> Ralf

Yes, I was thinking of using GitHub edition instead of the wiki for 
little changes. The good thing, as Ralf points out, is that you can add 
new commits.

Are there any numbers of editions submitted through the wiki lately? 
Because if people is not using it anyway, that system could be dropped 
in favor of GitHub. I don't think Edit + solving PR is more difficult 
than the wiki.

Juan Luis
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/scipy-dev/attachments/20130801/8007fade/attachment.html 


More information about the SciPy-Dev mailing list