[BioRuby-cvs] bioruby README.DEV,1.2,1.3

Katayama Toshiaki k at pub.open-bio.org
Fri Nov 4 12:31:34 EST 2005


Update of /home/repository/bioruby/bioruby
In directory pub.open-bio.org:/tmp/cvs-serv26366

Modified Files:
	README.DEV 
Log Message:
* sample header is changed to RDoc


Index: README.DEV
===================================================================
RCS file: /home/repository/bioruby/bioruby/README.DEV,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** README.DEV	26 Sep 2005 02:07:02 -0000	1.2
--- README.DEV	4 Nov 2005 17:31:32 -0000	1.3
***************
*** 53,59 ****
  
    #
!   # bio/foo/bar.rb - foo bar class
    #
!   #   Copyright (C) 2005 Ruby B. Hacker <rbh at example.org>
    #
    #  This library is free software; you can redistribute it and/or
--- 53,75 ----
  
    #
!   # = bio/foo/bar.rb - foo bar class
    #
!   # Copyright::	Copyright (C) 2005
!   #		Bio R. Hacker <brh at example.org>,
!   #		Chem R. Hacker <crh at example.org>
!   # Lisence::	LGPL
!   #
!   # $Id$
!   #
!   # == Blah blah blah
!   #
!   # blah blah blah ...
!   #
!   # === Examples
!   #
!   #   hoge = Bio::Foo::Bar.new
!   #   puts hoge.fuga
!   #
!   #--
    #
    #  This library is free software; you can redistribute it and/or
***************
*** 71,75 ****
    #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
    #
-   #  $Id$
    #
  
--- 87,90 ----
***************
*** 77,87 ****
  
  The RDoc format is becoming de facto standard for the Ruby documentation.
! 
! So, we are now in transition from the RD format to the RDoc format
! as we had been written the API documentations in the RD format and
! put them at the end of each file.
  
  Additional tutorial documents and some working examples are also
! welcome when you contribute your codes.
  
  === Testing code should use 'test/unit'
--- 92,102 ----
  
  The RDoc format is becoming de facto standard for the Ruby documentation.
! So, we are now in transition from the RD format which we have been used
! to the RDoc format in API documentations.
  
  Additional tutorial documents and some working examples are also
! welcome when you contribute your codes.  You may also able to use
! the header part of the file for this purpose as shown in the previous
! section.
  
  === Testing code should use 'test/unit'



More information about the bioruby-cvs mailing list