visualpython-users

[Visualpython-users] docstrings?

[Flavio C. <fcc...@gm...>]

Hi,

I am a new user of vpython, and I am very excited about its
capabilities and its potential.

However, there is one little aspect  of the python source that stroke
me as something that could be easily fixed, and would be of great help
to users and would-be-developers alike:
There is a total lack of docstrings in the whole source!! Besides
being very unpythonic, it prevents users from getting help on a class
or function.

I don't want this to sound like a complaint, but it is such an easy
thing (for the developers) to do, that I had to make this suggestion.

Otherwise the package is great and unparalleled in the python world.

congratulations,



--=20
Fl=E1vio Code=E7o Coelho
---------------------------
Great spirits have always found violent opposition from mediocrities. The
latter cannot understand it when a man does not thoughtlessly submit to
hereditary prejudices but honestly and courageously uses his intelligence.
        Albert Einstein

Re: [Visualpython-users] docstrings?

[Jonathan B. <jbr...@ea...>]

On Thu, 2005-01-20 at 19:33 -0200, Flavio Coelho wrote:
> Hi,
> 
> I am a new user of vpython, and I am very excited about its
> capabilities and its potential.
> 
> However, there is one little aspect  of the python source that stroke
> me as something that could be easily fixed, and would be of great help
> to users and would-be-developers alike:
> There is a total lack of docstrings in the whole source!! Besides
> being very unpythonic, it prevents users from getting help on a class
> or function.
> 
> I don't want this to sound like a complaint, but it is such an easy
> thing (for the developers) to do, that I had to make this suggestion.
> 
> Otherwise the package is great and unparalleled in the python world.
> 
> congratulations,

Are you using one of the versions in the 3.x series?  If so, I think you
will find that most of the functions have docstrings in them.
Unfortunately, Boost.Python does not support docstrings for properties
at this time.

-Jonathan