[Python-checkins] CVS: python/dist/src/Doc/perl python.perl,1.100,1.101

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/perl
In directory usw-pr-cvs1:/tmp/cvs-serv1409/perl

Modified Files:
	python.perl 
Log Message:

Define a new environment, classdesc*, which can be used to document a
class without providing any information about the constructor.  This
should be used for classes which only exist to act as containers rather
than as factories for instances.


Index: python.perl
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/perl/python.perl,v
retrieving revision 1.100
retrieving revision 1.101
diff -C2 -r1.100 -r1.101
*** python.perl	2001/04/21 05:48:07	1.100
--- python.perl	2001/05/11 01:00:30	1.101
***************
*** 907,910 ****
--- 907,921 ----
  }
  
+ sub do_env_classdescstar{
+     local($_) = @_;
+     $THIS_CLASS = next_argument();
+     $idx = make_str_index_entry(
+ 		"<tt class='class'>$THIS_CLASS</tt> (class in $THIS_MODULE)" );
+     $idx =~ s/ \(.*\)//;
+     return ("<dl><dt><b>class $idx</b>\n<dd>"
+             . $_
+             . '</dl>');
+ }
+ 
  sub do_env_excclassdesc{
      return handle_classlike_descriptor(@_[0], "exception");