Adding minimal module docstrings for the deprecated Bio.Writers/Bio.w…

…riters.* framework
biopython · Sep 22, 2008 · fd2e06b · fd2e06b
1 parent 7a34d63
commit fd2e06b
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 3 deletions.
diff --git a/Bio/Writer.py b/Bio/Writer.py
@@ -1,7 +1,10 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
+
 import warnings
-warnings.warn("Bio.Writer was deprecated, as any Biopython modules that used "\
-               +"it have been deprecated. If you do use this module, please "\
-               +"get in touch via the Biopython mailing list or bugzilla.")
+warnings.warn("Bio.Writer and Bio.writer.* are deprecated. If you do use"\
+              +" these modules, please get in touch via the mailing list or"\
+              +" bugzilla to avoid their permanent removal from Biopython.", \
+              DeprecationWarning)
 
 class Writer:
     def __init__(self, outfile):

diff --git a/Bio/writers/SeqRecord/__init__.py b/Bio/writers/SeqRecord/__init__.py
@@ -1 +1,2 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
 # This is a Python module.
diff --git a/Bio/writers/SeqRecord/embl.py b/Bio/writers/SeqRecord/embl.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
 # Not clear on the distinction, if any, between 'embl' and 'embl/65'.  This
 # code might apply to either or both.
 

diff --git a/Bio/writers/SeqRecord/empty.py b/Bio/writers/SeqRecord/empty.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
 from Bio import Writer
 
 class WriteEmpty(Writer.Writer):

diff --git a/Bio/writers/SeqRecord/fasta.py b/Bio/writers/SeqRecord/fasta.py
@@ -1,3 +1,4 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
 from Bio import Writer
 
 class WriteFasta(Writer.Writer):

diff --git a/Bio/writers/__init__.py b/Bio/writers/__init__.py
@@ -1 +1,3 @@
+"""Part of an old unused and undocumented sequence writing framework (DEPRECATED)."""
 # This is a Python module.
+# (there are more files underneath this directory)
diff --git a/DEPRECATED b/DEPRECATED
@@ -20,6 +20,10 @@ Bio.builders
 ============
 Part of the Martle/Mindy infrastructure, this was deprecated in Release 1.49
 
+Bio.Writer and Bio.writers
+==========================
+Deprecated in Release 1.48
+
 Bio.MetaTool
 ============
 Deprecated in Release 1.48, this was a parser from the output of MetaTool 3.5