BJ> Why does it have to be "wiki-like"? Why can't it be a wiki? MediaWiki
> seem to work pretty well for a lot of software projects that have put
> their documentation in a wiki. Talk pages for commentary and primary
> pages for reviewed content.
And inconsistent formatting from article to article
On Sat, 2006-01-21 at 19:15 -0500, Terry Reedy wrote:
> >> http://effbot.org/lib/os.path.join
>
> On this page, 8 of 30 entries have a 'new in' comment. For anyone with no
> interest in the past, these constitute noise. I wonder if for 3.0, the
Even the past is relative... I find the "new in"
Brett Cannon wrote:
> And to /F, kudos from me. I have been randomly thinking about it and
> I understand your desire for semantic markup now.
thanks.
> Hopefully something can get hammered out so that at least the Python
> 3 docs can premiere having been developed on by the whole community.
w
BJörn Lindqvist wrote:
> > > Have you studied wikipedia's approach? It's multi-layered and worth
> > > learning from (start with their FAQ on editing).
> > >
> > > (And by the way, I am *not* advocating writing the docs as one big
> > > wikipedia -- only the user commentary.)
> >
> > to clarify, I
> > Have you studied wikipedia's approach? It's multi-layered and worth
> > learning from (start with their FAQ on editing).
> >
> > (And by the way, I am *not* advocating writing the docs as one big
> > wikipedia -- only the user commentary.)
>
> to clarify, I'm advocating maintaining the docs via
> [Fredrik, later]
> > if we move over to a web-oriented (wiki-ish) maintenance model, we
> > probably have to accept that "X" will, sometimes, be a future release.
>
> This makes me worry that you're thinking of abandoning having separate
> docs per version. That would be a shame; I think the docs
Georg Brandl wrote:
>Tim Parkin wrote:
>
>>>Something like this...
>>>
>>>http://beta.python.org/download/releases/2.4.1/
>>>
>>>
>
>That's an ordinary float, I presume?
>
>
indeed it is.
>
>
>>It would also be simple to add an 'alternate stylesheet' that can hide
>>the left hand naviga
Tim Parkin wrote:
> Tim Parkin wrote:
>> Guido van Rossum wrote:
>>
>>>I believe there's a CSS trick (most often used for images) that can
>>>makes the summary window "float" to the right so that below it the
>>>main text resumes the full breadth of the window. If you can pull that
>>>off I think
Guido wrote:
> Have you studied wikipedia's approach? It's multi-layered and worth
> learning from (start with their FAQ on editing).
>
> (And by the way, I am *not* advocating writing the docs as one big
> wikipedia -- only the user commentary.)
to clarify, I'm advocating maintaining the docs vi
Facundo Batista wrote:
> 2006/1/22, Georg Brandl <[EMAIL PROTECTED]>:
>
>> Guido van Rossum wrote:
>> > ...
>> > Why? If wikipedia can do without moderation (for most pages) then why
>> > couldn't the Python docs?
>>
>> Well, why not... it's surely worth a try. Perhaps using a spam filter like
>
Tim Parkin wrote:
> Guido van Rossum wrote:
>
>>I believe there's a CSS trick (most often used for images) that can
>>makes the summary window "float" to the right so that below it the
>>main text resumes the full breadth of the window. If you can pull that
>>off I think this is a good addition!
>
Guido van Rossum wrote:
> I believe there's a CSS trick (most often used for images) that can
> makes the summary window "float" to the right so that below it the
> main text resumes the full breadth of the window. If you can pull that
> off I think this is a good addition!
>
>
Something like th
[Aahz]
>> Aside to Georg: your messages are all getting /dev/null'd because you use
>> "spam" in your From: line. I get too much spam to change that, and I'll
>> bet other people use that heuristic. Please change your From: line for
>> this mailing list.
[Georg Brandl]
> I don't quite understand
Guido van Rossum wrote:
>> > Which (despite having "perma" in its name) evaporates and leaves
>> > behind a link to os.path.html#join.
>
>> There may be other uses (e.g. marking a certain location in the docs with
>> a "permalink" marker so that one can point the user to /lib/marker.
>> Especiall
2006/1/22, Georg Brandl <[EMAIL PROTECTED]>:
> Guido van Rossum wrote:
> > ...
> > Why? If wikipedia can do without moderation (for most pages) then why
> > couldn't the Python docs?
>
> Well, why not... it's surely worth a try. Perhaps using a spam filter like
> most
> modern weblogs would suff
(This is a bulk reply to several messages in this thread from Georg
and Fredrik.)
[Georg]
> >> http://effbot.org/lib/os.path.join
[Guido]
> > Which (despite having "perma" in its name) evaporates and leaves
> > behind a link to os.path.html#join.
[Georg]
> There may be other uses (e.g. marking a
On 1/21/06, Georg Brandl <[EMAIL PROTECTED]> wrote:
> And, of course, the "new in 2.x" could be formatted less space-consuming,
> perhaps to the right of the method name.
No, that would give it too much attention.
It's getting way too outstanding in effbot's sample, probably because
he didn't imp
Fredrik Lundh wrote:
>> (this is the main motivator behind my documentation and site efforts; we
>
> should learn not to press control-enter when we mean enter.
>
> anyway, what I intended to say was that we should work harder on lowering the
> threshold for drive-by contributions; it should be p
Guido van Rossum wrote:
> > On this page, 8 of 30 entries have a 'new in' comment. For anyone with no
> > interest in the past, these constitute noise. I wonder if for 3.0, the
> > timer can be reset and the docs start clean again. To keep them backwards
> > compatible, they would also have to
> (this is the main motivator behind my documentation and site efforts; we
should learn not to press control-enter when we mean enter.
anyway, what I intended to say was that we should work harder on lowering the
threshold for drive-by contributions; it should be possible for anyone to
notice a
Georg Brandl wrote:
> > Vertical spacing is IMHO pretty bad on this page. Everything
> > has the same distance from everything else. This makes under-
> > standing the structure of the page pretty hard.
>
> The main content is the original zipfile.html from
> http://www.effbot.org/lib/zipfile.html
Guido wrote:
> > What Fredrik hacks together there (http://www.effbot.org/lib) is very
> > impressive. I especially like the "permalinks" in this style:
> >
> > http://effbot.org/lib/os.path.join
>
> Which (despite having "perma" in its name) evaporates and leaves
> behind a link to os.path.html#j
Walter Dörwald wrote:
> Georg Brandl wrote:
>
>>> [...]
>>> Can you mock that up a bit? I'm somewhat confused about what you're
>>> requesting, and also worried that it would take up too
>>> much horizontal space. (Despite that monitors are wider than tall,
>>> horizontal real estate feels more
Georg Brandl wrote:
>> [...]
>> Can you mock that up a bit? I'm somewhat confused about what you're
>> requesting, and also worried that it would take up too
>> much horizontal space. (Despite that monitors are wider than tall,
>> horizontal real estate feels more scarce than vertical,
>> becaus
Guido van Rossum wrote:
> On 1/21/06, Georg Brandl <[EMAIL PROTECTED]> wrote:
>> What Fredrik hacks together there (http://www.effbot.org/lib) is very
>> impressive. I especially like the "permalinks" in this style:
>>
>> http://effbot.org/lib/os.path.join
>
> Which (despite having "perma" in its
> For me, the "-nospam" suffix works relatively good to avoid spam,
> as most
> harvesting programs will think this is a false address.
http://spambayes.org works, too, without bothering others <0.5 wink>
=Tony.Meyer
___
Python-Dev mailing list
Python
Aahz wrote:
> On Sat, Jan 21, 2006, Guido van Rossum wrote:
>>
>> Why? If wikipedia can do without moderation (for most pages) then why
>> couldn't the Python docs?
>
> If we're strictly talking about user comments, I won't disagree, but the
> main docs do need to be "authoritative" IMO.
>
> Asi
Georg Brandl wrote:
> Guido van Rossum wrote:
>> As far as noise goes, "new in X" is minor compared to all the stuff
>> that's documented that the average user never needs... :-)
>
> And, of course, the "new in 2.x" could be formatted less space-consuming,
> perhaps to the right of the method name
Guido van Rossum wrote:
> On 1/21/06, Terry Reedy <[EMAIL PROTECTED]> wrote:
>> On this page, 8 of 30 entries have a 'new in' comment. For anyone with no
>> interest in the past, these constitute noise. I wonder if for 3.0, the
>> timer can be reset and the docs start clean again. To keep them b
On Sat, Jan 21, 2006, Guido van Rossum wrote:
>
> Why? If wikipedia can do without moderation (for most pages) then why
> couldn't the Python docs?
If we're strictly talking about user comments, I won't disagree, but the
main docs do need to be "authoritative" IMO.
Aside to Georg: your messages
On 1/21/06, Terry Reedy <[EMAIL PROTECTED]> wrote:
> On this page, 8 of 30 entries have a 'new in' comment. For anyone with no
> interest in the past, these constitute noise. I wonder if for 3.0, the
> timer can be reset and the docs start clean again. To keep them backwards
> compatible, they w
>> http://effbot.org/lib/os.path.join
On this page, 8 of 30 entries have a 'new in' comment. For anyone with no
interest in the past, these constitute noise. I wonder if for 3.0, the
timer can be reset and the docs start clean again. To keep them backwards
compatible, they would also have to
On 1/21/06, Georg Brandl <[EMAIL PROTECTED]> wrote:
> What Fredrik hacks together there (http://www.effbot.org/lib) is very
> impressive. I especially like the "permalinks" in this style:
>
> http://effbot.org/lib/os.path.join
Which (despite having "perma" in its name) evaporates and leaves
behind
What Fredrik hacks together there (http://www.effbot.org/lib) is very
impressive. I especially like the "permalinks" in this style:
http://effbot.org/lib/os.path.join
What I would suggest (for any new doc system) is a "split" view: on the left,
the normal text, on the right, an area with only t
34 matches
Mail list logo
