[EMAIL PROTECTED] wrote:
That's why I have started a collaborative project to make a user
contributed Python documentation. The wiki is online here:
http://www.pythondocs.info
Frankly I'm tired of these yet-another-wiki announcements!
Who is supposed to fill them with content?
If you have
[EMAIL PROTECTED] wrote:
Wildemar Wildenburger wrote:
[EMAIL PROTECTED] wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
Where have
Rakotomandimby (R12y) wrote:
On Sat, 16 Sep 2006 22:43:41 +0200, Daniel Nogradi wrote:
Then how about running your site on python and not php?
PHP has better documentation... ;-)
More seriously, I can provide a CPS hosting to nicolasfr if he wants.
Alert ! Unusable undocumented monstruosity
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
On Sunday 17 September 2006 04:31, Brad Allen wrote:
Here is an idea for improving Python official documentation:
Provide a tab-based interface for each entry, with the overview/summary
at the top-level, with a row of tabs underneath:
1. Official documentation, with commentary posted
Rakotomandimby (R12y) wrote:
On Sat, 16 Sep 2006 12:30:56 -0700, Robert Hicks wrote:
That said...the Python docs are open source. Just start going through
them and adding examples.
ASPN (activestate) is a good place for examples...
Yes, but that requires a separate search and depends on
That said...the Python docs are open source. Just start going through
them and adding examples.
ASPN (activestate) is a good place for examples...
Yes, but that requires a separate search and depends on an external
organization. Wouldn't it be great if relevant examples were a single
Somehow all of the above discussions did not mention having examples or
demos built-in for the language itself:
majorfunction.example()
demo(package) or package.demo()
search engine in local html documentation
apropos()
The statistical software R is bettter in this respect if
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
Kay Schluehr wrote:
Personally, I never found the Python docs particular bad. It is
rewarding to write good documentation because documentation has
different aspects i.e. introductory/tutorial, exhaustive/manual and
design documentation aspects. Not to mention cookbook recipes.
I also
On Sun, 17 Sep 2006 18:10:51 +0200,
Daniel Nogradi [EMAIL PROTECTED] wrote:
start a new one. What would be very useful though is more visible
links on the python.org site to the activestate repository where
appropriate. I'm not sure the pyhon.org people would want to promote
A.M. Kuchling wrote:
However, this code isn't used at the moment because I have no idea
what to do about version controlling the links. Do we just use the
current links whenever the HTML is generated? Make a copy of the list
and commit them into SVN, so the links cease to be updated but are
On 9/17/06, A.M. Kuchling [EMAIL PROTECTED] wrote:
On Sun, 17 Sep 2006 18:10:51 +0200,
Daniel Nogradi [EMAIL PROTECTED] wrote:
start a new one. What would be very useful though is more visible
links on the python.org site to the activestate repository where
appropriate. I'm not
Brad Allen wrote:
A.M. Kuchling wrote:
However, this code isn't used at the moment because I have no idea
what to do about version controlling the links. Do we just use the
current links whenever the HTML is generated? Make a copy of the list
and commit them into SVN, so the links
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
That's why I have
[EMAIL PROTECTED] wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
Where have you read that?
wildemar
--
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
Wildemar Wildenburger wrote:
[EMAIL PROTECTED] wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
Where have you read that?
On Saturday 16 September 2006 19:16, [EMAIL PROTECTED] wrote:
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times
[EMAIL PROTECTED] wrote:
Wildemar Wildenburger wrote:
[EMAIL PROTECTED] wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
On Sat, 16 Sep 2006 10:40:43 -0700, nicolasfr wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
Where have you read that?
Christoph Haas wrote:
On Saturday 16 September 2006 19:16, [EMAIL PROTECTED] wrote:
snip
I second that the Python documentation is lacking. There is no software
that is adequately documented anyway. Show me a man page of a Perl module
and it takes me minutes to use it.
I would say that Perl
[EMAIL PROTECTED] wrote:
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.
Rakotomandimby (R12y) wrote:
What you should have done first is to suggest to contribute to the
official Python doc.
I wrote an email a few months ago to the Python docs support email
address to offer my help but never got any answer.
Then, if you encounter too much dumbs (and only in that
Everytime I am lookink at how to do this or that in Python I write it
down somewhere on my computer. (For ex. Threading. After reading the
official documentation I was a bit perplex. Hopefully I found an
article an managed to implement threads with only like 20 lines of code
in my script.
[EMAIL PROTECTED] wrote:
Rakotomandimby (R12y) wrote:
What you should have done first is to suggest to contribute to the
official Python doc.
I wrote an email a few months ago to the Python docs support email
address to offer my help but never got any answer.
What did that email say?
-
I would like to see more than one source.. Not that the documentation
is good or bad it is just that different people may come up with
different ways to explain the same thing and that is good in my view.
I would like to see the re module and the string module with as many
examples as humanly
[EMAIL PROTECTED] wrote:
Hi,
I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
On Sat, 16 Sep 2006 22:43:41 +0200, Daniel Nogradi wrote:
Then how about running your site on python and not php?
PHP has better documentation... ;-)
More seriously, I can provide a CPS hosting to nicolasfr if he wants.
--
http://mail.python.org/mailman/listinfo/python-list
On Sat, 16 Sep 2006 12:30:56 -0700, Robert Hicks wrote:
That said...the Python docs are open source. Just start going through
them and adding examples.
ASPN (activestate) is a good place for examples...
--
http://mail.python.org/mailman/listinfo/python-list
* [EMAIL PROTECTED] (2006-09-16 18:40 +0100)
Wildemar Wildenburger wrote:
[EMAIL PROTECTED] wrote:
I have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it
Here is an idea for improving Python official documentation:
Provide a tab-based interface for each entry, with the overview/summary
at the top-level, with a row of tabs underneath:
1. Official documentation, with commentary posted at the bottom
(ala Django documentation)
2.
34 matches
Mail list logo
