This week's giveaway is in the Spring forum.
We're giving away four copies of REST with Spring (video course) and have Eugen Paraschiv on-line!
See this thread for details.
The moose likes Jython/Python and the fly likes Python Documentation Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of REST with Spring (video course) this week in the Spring forum!
JavaRanch » Java Forums » Languages » Jython/Python
Bookmark "Python Documentation" Watch "Python Documentation" New topic

Python Documentation

gaurav gaurav

Joined: Feb 04, 2005
Posts: 3
hi to all,

i am new to this forum and i need some help from all of u . I want to know how to write the documentation for the function used in Python . so i expecting help from u all i need it very urgent
Pauline McNamara

Joined: Jan 19, 2001
Posts: 4012
Welcome to Javaranch gaurav gaurav,

I have a feeling this question might not get the answer you are hoping for.

First a couple of administrative details...

Remember the naming policy that you agreed to when you signed up? We don't have many rules, but we stick by that one. Please change your display name so it has two different names instead of 2 first names.

Then you might want to check out these guidelines about how to ask questions that get answered: Asking Questions the Smart Way

The Teacher's Lounge is a forum about teaching, where people who do teaching talk about teaching. Your question might have a better chance in a forum where people who do Python talk about Python. Maybe the Object Oriented Scripting forum?

This question will be moved over to the Object Oriented Scripting forum shortly...

Hope you'll be visiting the ranch often!

[ February 04, 2005: Message edited by: Pauline McNamara ]
Karthik Guru
Ranch Hand

Joined: Mar 06, 2001
Posts: 1209
Just write the documentation with double quotes after class declaration for documenting the class. Do a similar thing for methods after method declaration.

The class and the methods have a __doc__ attriute and the documentation strings will get bound to them.

I agree. Here's the link:
subject: Python Documentation
jQuery in Action, 3rd edition