How to Replace Python Directions

Python programmers use the "def buildConnectionString" function to document classes.

Python, like other object-oriented languages, allows you to create your own classes to perform specialized tasks. These can either be for your use exclusively, or for sharing them with other programmers for their own Python projects. When you write these classes, you can write instructions on how to use the class that any programmer can access through Python's interactive shell. However, as you work on your own class, or modify someone else's class, you may find it necessary to update these instructions.

Instructions

1. Open your Python class file in your preferred text editor.

2. Locate the directions for your class, which will be located under the heading, "def buildConnectionString(params)."

3. Delete the text within the quotation marks, and replace them with your new directions for that class.

4. Save the file and quit the text editor.

References

• Dive into Python; 2.3. Documenting Functions; Mark Pilgrim; 2004
• Python Documentation: 3.1 Data Model - 3.1. Objects, Values and Types