Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Python > Principles of documentation (was: Python Documentation Blows!)

Reply
Thread Tools

Principles of documentation (was: Python Documentation Blows!)

 
 
Cameron Laird
Guest
Posts: n/a
 
      04-03-2004
In article <c4dpro$5vg$>,
Josiah Carlson <> wrote:
.
.
.
>better. Maybe it was that year of only really knowing C and C++ that
>makes the difference, but I've never had issue with the wxWidgets
>documentation.
>
>While I prefer Python's name with description later, having the type of
>input and output from the function call given in the function definition
>is convenient. Programming with a language that is static typed may be
>a pain in the ass, but it is damn convenient when you are looking at
>documentation. Even though wxWidgets class definitions can have huge
>initialization argument lists, generally you can be sure of what you are
>supposed to pass into something, and what you can expect in return.
>
>
> - Josiah


We're different--always interesting. As a heavy consumer and
producer of documentation, "having the type .. in the function
definition is convenient" intrigues me. Clouding my thoughts
a bit is C's wimpy type system ('love the language, 'recognize
its limits). Your proposition sounds to me much like what we
used to believe about compile-time syntax checking, versus
more robust and application-specific unit tests.

My preliminary reaction, therefore: yes, indeed, type declar-
ations are important, Python documenters should be particularly
careful always to specify them explicitly, and, if anything,
Python has the chance to improve on the standards C and C++ set,
as its typing is stronger.
--

Cameron Laird <>
Business: http://www.Phaseit.net
 
Reply With Quote
 
 
 
 
Josiah Carlson
Guest
Posts: n/a
 
      04-03-2004
> We're different--always interesting. As a heavy consumer and
> producer of documentation, "having the type .. in the function
> definition is convenient" intrigues me. Clouding my thoughts
> a bit is C's wimpy type system ('love the language, 'recognize
> its limits). Your proposition sounds to me much like what we
> used to believe about compile-time syntax checking, versus
> more robust and application-specific unit tests.


Goodness, please don't lump me with the compile-time syntax checking
zealots *wink*. I'm talking about convenience in documentation of C/C++
functions; it tells you what you /should/ be passing in. No more, no
less. I find reading such type signatures to be quicker than linguistic
descriptions of the passed arguments.

One really nifty thing about decorators (PEP 31 is that people will
have the option of strong and dynamically typed polymorphism, but the
drawback is that we may get some C++ or Java programmers who use it for
everything, even when it is not necessary or detrimental.


> My preliminary reaction, therefore: yes, indeed, type declar-
> ations are important, Python documenters should be particularly
> careful always to specify them explicitly, and, if anything,
> Python has the chance to improve on the standards C and C++ set,
> as its typing is stronger.


Agreed.

- Josiah
 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Concurrent Programming in Java(TM): Design Principles and Pattern (3nd Edition) puzzlecracker Java 0 07-20-2006 07:07 PM
"Principles Of Compiler Design" answers to questions steven.bagnall@churchillchina.plc.uk C++ 0 03-18-2005 05:46 AM
Switch Spec and Design Principles Michael Cisco 1 05-31-2004 02:16 AM
CFP International Conference on the Principles and Practice of Programming in Java pppj Java 0 01-15-2004 01:17 PM
Advice on design approach and principles Mr Gordonz ASP .Net 1 08-04-2003 10:08 PM



Advertisments
 



1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57