[IPython-dev] Quick launchpad guide for would-be contributors

Brian Granger ellisonbg.net@gmail....
Tue Jun 3 13:45:02 CDT 2008


Also, I have started a rst/Sphinx based developer's guidelines in
ipython1.  I based it on the wiki initially, but has more info on
certain fronts - especially on the stuff that is relevant to ipython1
merging with IPython.  When I do the merge of ipython1->IPython, I
will also merge the developer related things.

This brings up a bigger issue.  I would like _all_ of our docs to be
Sphinx based.  And in my mind, the developer guidelines fall under
this.  I don't like having to maintain multiple documentation sets
(wiki + Sphinx) and I think the Sphinx docs are a better place for all
of these things, including the developer related things.  We should
save the wiki for things like the cookbook and the basic web presence
for IPython.  How does this sound?

Brian



On Tue, Jun 3, 2008 at 12:37 PM, Fernando Perez <fperez.net@gmail.com> wrote:
> On Tue, Jun 3, 2008 at 11:01 AM, Ville M. Vainio <vivainio@gmail.com> wrote:
>> Here is a short guide to launchpad I wrote for Leo editor. It's
>> applicable to ipython as well, when you substitute "ipython" for
>> "leo-editor"
>
> One more thing: in here, the workflow you describe will lead to the
> 'history folding' problem we were having, no?  You don't indicate
> keeping the dual-branch approach we'd discussed before and that I put
> in the version of the guide I uploaded over the weekend.
>
> The more I think about it, the more I think that no matter what we do,
> the web history view will never be 100% correct: lp made the decision
> to have a flat history view, and for a system that's fundamentally
> based on branching, there will alyways be cases where the linear view
> will fail to properly show the branch evolution and remerging.
>
> But I do want to clarify (simply because *I* am not 100% sure what the
> right solution is) if the dual-branch approach advocated earlier is
> correct, necessary, useful, etc.
>
> Cheers,
>
> f
> _______________________________________________
> IPython-dev mailing list
> IPython-dev@scipy.org
> http://lists.ipython.scipy.org/mailman/listinfo/ipython-dev
>


More information about the IPython-dev mailing list