On Fri, Jul 31, 2009 at 11:35 PM, Edward Z. Yang wrote:
> Excerpts from Itamar Shtull-Trauring's message of Fri Jul 31 22:26:29 -0400
> 2009:
> > The problem with this is that it perpetuates the misunderstanding the
> > Deferreds *make* things asynchronous, even with the intro that says
> > other
On Sat, Aug 1, 2009 at 12:11 AM, Steve Steiner <
list...@integrateddevcorp.com> wrote:
> > I hope you can see why I want to hold on to our current toolchain
> > until we have someone around who has demonstrated a much deeper
> > commitment to documentation than anyone yet has. For example,
> > St
On Fri, Jul 31, 2009 at 6:40 PM, Edward Z. Yang wrote:
> You can view an initial draft of the rewrite here:
This is a great first draft! Very substantial. I really appreciate you
working on this.
Now I will proceed to rip it to shreds by way of giving you some feedback,
but please try to tak
> I hope you can see why I want to hold on to our current toolchain
> until we have someone around who has demonstrated a much deeper
> commitment to documentation than anyone yet has. For example,
> Steve, if you close 100 existing documentation tickets in the next
> week, then make the e
Excerpts from Itamar Shtull-Trauring's message of Fri Jul 31 22:26:29 -0400
2009:
> The problem with this is that it perpetuates the misunderstanding the
> Deferreds *make* things asynchronous, even with the intro that says
> otherwise. I think it's better to assume already asynchronous code,
> ha
On Fri, Jul 31, 2009 at 11:10 PM, Steve Steiner (listsin) <
list...@integrateddevcorp.com> wrote:
> Since "everything" is not in the build system anyway, perhaps starting
> a branch, in a new build system (Sphinx), where we pull things in, one
> chunk at a time, will not be a hit and run approach,
On Fri, Jul 31, 2009 at 10:25 PM, Itamar
Shtull-Trauring wrote:
> Could you file some bugs to that effect, so we don't forget these
> suggestions? Thanks!
Done: http://twistedmatrix.com/trac/ticket/3945
The formatting on the description is off though (I tried to make
bullet points and failed),
On Jul 31, 2009, at 4:23 PM, Glyph Lefkowitz wrote:
...
> I certainly wouldn't mind switching to a tool that has lots of fancy
> features that lore lacks, but a hit-and-run approach where we just
> switch tools in the hopes that it will make something better may
> leave us in a worse situati
On Jul 31, 2009, at 10:25 PM, Itamar Shtull-Trauring wrote:
> On Fri, 2009-07-31 at 15:37 -0400, Ying Li wrote:
>
>> version (currently 8.2.0) but this is meaningless to me. I think a
>> big improvement would be putting in a small bit of context around the
>> documentation , such as:
>>
>> * whe
On Fri, 2009-07-31 at 15:37 -0400, Ying Li wrote:
> version (currently 8.2.0) but this is meaningless to me. I think a
> big improvement would be putting in a small bit of context around the
> documentation , such as:
>
> * when the howto/tutorial was last updated
> * what version (of deferreds/
On Fri, 2009-07-31 at 18:40 -0400, Edward Z. Yang wrote:
> You can view an initial draft of the rewrite here:
>
> http://ezyang.com/twisted/defer2.html
>
> For reference, this is the planned outline (X means done, ? means
> almost done):
>
> X Synchronous to Asynchronous: The Method to the Madne
You can view an initial draft of the rewrite here:
http://ezyang.com/twisted/defer2.html
For reference, this is the planned outline (X means done, ? means
almost done):
X Synchronous to Asynchronous: The Method to the Madness
X Convert synchronous code to asynchronous code
X Why asynchro
On Fri, Jul 31, 2009 at 4:20 PM, Laurens Van Houtven wrote:
> Also, regarding the message classes at every level: does this include
> the top level? I thought the top level (eg most abstracted) would
> contain a number of callbacks, such as:
>
>positionReceived(self, latitude, longitude)
>
On Fri, Jul 31, 2009 at 1:16 PM, Jessica McKellar <
jessica.mckel...@gmail.com> wrote:
> I am not scared off. In fact, I'm updating the
> wiki/ContributingToTwistedLabs and related how-to-edit-documentation pages
> right now.
>
I see the edits in the timeline. They look great! Thanks! :-D
Do y
Also, regarding the message classes at every level: does this include
the top level? I thought the top level (eg most abstracted) would
contain a number of callbacks, such as:
positionReceived(self, latitude, longitude)
positionErrorReceived(self, hdop, vdop, pdop)
altitudeReceived(sel
On Jul 31, 2009, at 3:37 PM, Ying Li wrote:
> On Fri, Jul 31, 2009 at 10:19 AM, Santiago
> Aguiar wrote:
>> My suggestion would be that more than *adding* documentation, I would
>> suggest to first search-and-destroy deprecated documentation. For me,
>> one of the most frustrating parts of using
On Jul 31, 2009, at 2:15 PM, Kevin Horn wrote:
> Well, pragmatism is my basic reason for not liking wikis for docs. :)
>
> For me, it boils down to every time I've worked on or with a project
> that used wikis for docs (assuming that the project is of at least
> moderate size and has more than
On Fri, Jul 31, 2009 at 10:19 AM, Santiago
Aguiar wrote:
> My suggestion would be that more than *adding* documentation, I would
> suggest to first search-and-destroy deprecated documentation. For me,
> one of the most frustrating parts of using twisted was reading through
> the twisted core doc, t
On Fri, Jul 31, 2009 at 12:57 PM, Phil Christensen wrote:
>
> On Jul 31, 2009, at 1:34 PM, Kevin Horn wrote:
> > >Also, what do the Twisted core devs think about having a secondary
> > >wiki/cookbook thingy outside of the core docs?
> >
> > As a staging area for development of future core docs, I
On Fri, Jul 31, 2009 at 12:16 PM, Jessica McKellar <
jessica.mckel...@gmail.com> wrote:
> I am not scared off. In fact, I'm updating the
> wiki/ContributingToTwistedLabs and related how-to-edit-documentation pages
> right now.
>
Great! I think that this is a critical first step.
> I think addi
On Jul 31, 2009, at 1:34 PM, Kevin Horn wrote:
> >Also, what do the Twisted core devs think about having a secondary
> >wiki/cookbook thingy outside of the core docs?
>
> As a staging area for development of future core docs, I think I would
> recommend using a version control system (perhaps a di
On Fri, Jul 31, 2009 at 12:11 PM, Kevin Horn wrote:
> On Fri, Jul 31, 2009 at 11:52 AM, Phil Christensen
> wrote:
>
>>
>> My only question about Sphinx, isn't it just for API docs? Also, can
>> it interpret Zope interfaces like pydoctor can?
>>
>
> AFAIK Sphinx does not have support for Zope int
On Fri, Jul 31, 2009 at 12:11 PM, Jean-Paul Calderone wrote:
> On Fri, 31 Jul 2009 11:55:08 -0500, Kevin Horn
> wrote:
> > [snip]
> >
> >I'd love to see a documentation "reboot" using Sphinx, but not if it's
> going
> >to be a half-baked, never-finished project.
> >
> > [snip]
> >
> >I'd also be
On Jul 31, 2009, at 1:11 PM, Jean-Paul Calderone wrote:
> As a staging area for development of future core docs, I think I would
> recommend using a version control system (perhaps a distributed one),
> not a wiki.
What I was suggesting originally was that a wiki would be a staging
ground for th
I am not scared off. In fact, I'm updating the
wiki/ContributingToTwistedLabs and related how-to-edit-documentation pages
right now.
I think adding content to and restructuring the howtos gives me a full plate
already, and to be honest I'm more interested in the content than the
presentation. Peop
On Fri, Jul 31, 2009 at 11:52 AM, Phil Christensen wrote:
>
> My only question about Sphinx, isn't it just for API docs? Also, can
> it interpret Zope interfaces like pydoctor can?
>
Sphinx is great for writing all sorts of docs. At its core, it's basically
a system for gluing together a bunch o
On Fri, 31 Jul 2009 11:55:08 -0500, Kevin Horn wrote:
> [snip]
>
>I'd love to see a documentation "reboot" using Sphinx, but not if it's going
>to be a half-baked, never-finished project.
>
> [snip]
>
>I'd also be interested in hearing the opinions of some of the core Twisted
>guys on the various
On Fri, Jul 31, 2009 at 11:14 AM, Santiago Aguiar wrote:
> Reza Lotun wrote:
> > Rather than change the documentation system entirely, who don't we
> > just create a new resource for Twisted documentation - a Twisted
> > Documentation Wiki. At the very least it can be a repository of
> > various
On Jul 31, 2009, at 12:32 PM, Reza Lotun wrote:
>> Even if I re-suggested the wiki based documentation, I think it's
>> important to be extra careful on how it's used. One thing I
>> personally
>> hate is projects whose documentation is basically wiki-based, and
>> what
>> you end having is a d
> Even if I re-suggested the wiki based documentation, I think it's
> important to be extra careful on how it's used. One thing I personally
> hate is projects whose documentation is basically wiki-based, and what
> you end having is a disconnected set of tips, many out of date, of how
> to do this
Reza Lotun wrote:
> Rather than change the documentation system entirely, who don't we
> just create a new resource for Twisted documentation - a Twisted
> Documentation Wiki. At the very least it can be a repository of
> various tips and tricks we happen to find, and maybe it can even be a
> stagi
On Fri, Jul 31, 2009 at 9:07 AM, Terry Jones wrote:
> > "Michael" == Michael Hudson writes:
> Michael> The accompanying paper is here:
> http://mumak.net/stuff/twisted-intro.html
>
> I agree, that's a really nicely done document. It would be good to extend
> it, moving into a description an
Hi All,
> Well, if there *were* to be a change in the documentation system used, I
> would push for moving to Sphinx, rather than a wiki.
>
> * it's rapidly becoming a "standard" for docs in the Python world
> * it has lots of neat features
> * it can be version controlled
> * multiple output for
- Original Message -
From: Kevin Horn
"Sometimes I think what is needed is someone who knows basically nothing
about Twisted to go about learning it...and then writing down how they did
it."
I'm trying to do this, by keeping notes as I learn twisted to build a custom
email system. It's ha
On Fri, Jul 31, 2009 at 9:34 AM, Phil Christensen wrote:
> On Jul 31, 2009, at 10:19 AM, Santiago Aguiar wrote:
> > It could also be a good idea to try to make it more wiki-like at the
> > beginning; I think there's quite a lot of people that would like to
> > contribute with this, but having diff
On Jul 31, 2009, at 10:19 AM, Santiago Aguiar wrote:
> It could also be a good idea to try to make it more wiki-like at the
> beginning; I think there's quite a lot of people that would like to
> contribute with this, but having different documents/styles for
> different areas of the doc is not goo
Hi Jessica!
I'm quite a newbie at twisted yet, and a newcomer to the project, so I
do think that twisted documentation is one of it's more problematic areas!.
My suggestion would be that more than *adding* documentation, I would
suggest to first search-and-destroy deprecated documentation. For
> "Michael" == Michael Hudson writes:
Michael> The accompanying paper is here:
http://mumak.net/stuff/twisted-intro.html
I agree, that's a really nicely done document. It would be good to extend
it, moving into a description and explanation of deferreds.
Terry
38 matches
Mail list logo
