Win a copy of Functional Reactive Programming this week in the Other Languages forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Python Documentation

 
gaurav gaurav
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Sheriff
Posts: 4012
6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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!

Pauline
[ February 04, 2005: Message edited by: Pauline McNamara ]
 
Karthik Guru
Ranch Hand
Posts: 1209
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.


 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic