← Back to branch summary

~pythonregexp2.7/python/issue2636-12

« back to all changes in this revision

Viewing changes to Doc/library/inspect.rst

  • Committer: Jeffrey C. "The TimeHorse" Jacobs
  • Date: 2008-06-09 14:52:42 UTC
  • mfrom: (39033.1.3 Regexp-2.6)
  • Revision ID: darklord@timehorse.com-20080609145242-9m268zc6u87rp1vp
Merged in changes from the core Regexp branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doc/library/inspect.rst
376
376
Retrieving source code
377
377
----------------------
378
378
 
379
 
 
380
379
.. function:: getdoc(object)
381
380
 
382
 
   Get the documentation string for an object. All tabs are expanded to spaces.  To
383
 
   clean up docstrings that are indented to line up with blocks of code, any
384
 
   whitespace than can be uniformly removed from the second line onwards is
385
 
   removed.
 
381
   Get the documentation string for an object, cleaned up with :func:`cleandoc`.
386
382
 
387
383
 
388
384
.. function:: getcomments(object)
429
425
   cannot be retrieved.
430
426
 
431
427
 
 
428
.. function:: cleandoc(doc)
 
429
 
 
430
   Clean up indentation from docstrings that are indented to line up with blocks
 
431
   of code.  Any whitespace that can be uniformly removed from the second line
 
432
   onwards is removed.  Also, all tabs are expanded to spaces.
 
433
 
 
434
   .. versionadded:: 2.6
 
435
 
 
436
 
432
437
.. _inspect-classes-functions:
433
438
 
434
439
Classes and functions